Skip to content
Typography

Anchor

server23 kB
@stellaria/nebula-webAnchorProps

Preview

Props

9
PropTypeDefault

children

ReactNode

—

className

Composes with the classes `Box` computes instead of replacing them.

string

—

component

The element it paints, and the seam where a router plugs in: pass your framework's link component (`component={NextLink}`) and its own props travel through untouched. It is why the core carries no router dependency.

(ElementType & C)"a"

external

Opens in a new tab and adds `rel="noopener noreferrer"` in the same move — the two go together so an external target can never reach `window.opener`. Both are spread before the rest, so an explicit `target` or `rel` of your own still wins.

booleanfalse

inherit

Takes family, size, weight and line height from the parent instead of the `Text` defaults. For text that must sit inside a heading or a button without breaking its type.

boolean

—

lines

Clamps the text to this many lines with an ellipsis. Beats `truncate`, and only applies above zero. Needs a width to work against: inside a flex child, that usually means `miw={0}`.

number

—

reveal

Animates the element in when it first scrolls into view. `true` takes the catalogue entrance; an object tunes it — `preset`, `distance`, `spring`, `duration`, `once`, `amount`, `rootMargin` and `index` for a stagger. It lives here rather than on each surface so that `Card`, `Paper`, `GradientBorder`, `Section` and anything else built on `Box` inherit one implementation. Without it `Box` stays a server component; with it the root swaps for a client shell and the children keep rendering on the server. The entrance is a CSS transition, not a JavaScript animation: it is the only motion in the catalogue that fires WHILE the user scrolls, and the compositor should own it.

boolean | UseRevealOptions

—

truncate

Cuts the text to a single line with an ellipsis. Ignored when `lines` is set, which does the same thing over several lines. The full text stays in the DOM, so it is still read aloud.

boolean

—

underline

When the underline shows. It is on always because the link has to be tellable from body text without relying on colour; `"hover"` and `"never"` move that job onto something else, and the surrounding design has to provide it.

AnchorUnderline"always"

Also accepts

On top of its own props, this component forwards these groups.

Style props · 128