Askr documentation
Generated API snapshot

@askrjs/themes/separator

Exports from the declarations published in @askrjs/themes. Signatures reflect the published artifact.

Exports

This entrypoint publishes 5 exports. Use the anchored symbol rows for direct links. Type-only exports are labeled separately from runtime values.

Separatortype

Separator: { (props: SeparatorNativeProps): JSX.Element; (props: SeparatorAsChildProps): JSX.Element; }

Visual divider, defaulting to horizontal role="separator"; pass decorative to drop the semantic role, or asChild to merge onto a single child element.

SeparatorAsChildPropstype

SeparatorAsChildProps: SeparatorOwnProps & {
  asChild: true;
  children: JSXElement;
  ref?: Ref<unknown>;
}

Props for {@link Separator } rendered with asChild, merging its attributes onto a single child element.

asChild
asChild: true;
children
children: JSXElement;
decorative
decorative?: boolean | undefined;
orientation
orientation?: "vertical" | "horizontal" | undefined;
ref
ref?: Ref<unknown>;

SeparatorNativePropstype

SeparatorNativeProps: Omit<JSX.IntrinsicElements["div"], "children" | "ref"> & SeparatorOwnProps & {
  asChild?: false;
  ref?: Ref<HTMLDivElement>;
}

Props for {@link Separator } rendered as its default <div> element.

asChild
asChild?: false | undefined;
children
children?: unknown;
decorative
decorative?: boolean | undefined;
orientation
orientation?: "vertical" | "horizontal" | undefined;
ref
ref?: Ref<HTMLDivElement>;

SeparatorOwnPropstype

SeparatorOwnProps: {
  decorative?: boolean;
  orientation?: "horizontal" | "vertical";
  children?: unknown;
}

Props shared by both {@link Separator } call signatures.

children
children?: unknown;
decorative
decorative?: boolean | undefined;
orientation
orientation?: "vertical" | "horizontal" | undefined;

SeparatorPropstype

SeparatorProps: SeparatorNativeProps | SeparatorAsChildProps

Union of all prop shapes accepted by {@link Separator }.

asChild
asChild?: boolean | undefined;
children
children?: unknown;
decorative
decorative?: boolean | undefined;
orientation
orientation?: "vertical" | "horizontal" | undefined;
ref
ref?: ((value: unknown) => void) | { current: unknown; } | ((value: HTMLDivElement | null) => void) | { current: HTMLDivElement | null; } | null | undefined;