@octopusdeploy/design-system-components/dist/src/components/Divider/Divider.d.ts

The design systems component library.

type DividerOrientation = "horizontal" | "vertical";
export interface DividerProps {
    /**
     * The orientation of the divider.
     * @remarks The vertical orientation requires a parent container using
     * a flexbox display to be visible.
     */
    orientation?: DividerOrientation;
    /**
     * Whether the divider should be hidden from assistive technologies.
     * @default true
     * @remarks /**
     * If the divider is purely decorative, set `aria-hidden` to true to hide it from assistive technologies.
     * If it serves a semantic purpose—visually separating meaningful sections do not hide and set this to false.
     * Screen readers will announce it as something like “Horizontal Splitter” or “Vertical Splitter,” so consider whether
     * that information adds value for the user.
     */
    ariaHidden?: boolean;
}
/**
 * A divider is a visual separator between content. It can be used to separate content into groups or to visually
 * separate content on a page.
 * @param props - The props for the divider.
 * @param props.orientation - The orientation of the divider.
 * @param props.ariaHidden - Whether the divider should be hidden from assistive technologies.
 * @returns A divider component.
 */
export declare function Divider({ orientation, ariaHidden }: DividerProps): import("react/jsx-runtime").JSX.Element;
export {};