carbon-react/lib/components/divider/divider.component.d.ts

A library of reusable React components for easily building user interfaces.

import { SpaceProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags";
export interface DividerProps extends SpaceProps, TagProps {
    /** Sets Divider type */
    type?: "vertical" | "horizontal";
    /** Sets Divider variant */
    variant?: "typical" | "prominent";
    /** Set the style of the Divider to inverse */
    inverse?: boolean;
    /** Shorthand for the height attribute.
     * Only available for the `vertical` type.
     * */
    h?: number | string;
    /** Height attribute of the component.
     * Only available for the `vertical` type.
     * */
    height?: number | string;
    /**
     * Sets the display: inline css attribute on the component
     * To be used in non-flex containers.
     * Only available for the `vertical` type.
     */
    displayInline?: boolean;
    /**
     * Set the divider to be hidden from screen readers.
     * Please note that this cannot be overridden when inside a Menu.
     * */
    "aria-hidden"?: boolean;
    /** Breakpoint for adaptive left and right margins (below the breakpoint they go to 0).
     * Enables the adaptive behaviour when set.
     * Only available for `horizontal` type.
     * */
    adaptiveMxBreakpoint?: number;
}
export declare const Divider: {
    ({ type, h, height, displayInline, "aria-hidden": ariaHidden, variant, inverse, adaptiveMxBreakpoint, ml, mr, ...rest }: DividerProps): JSX.Element;
    displayName: string;
};
export default Divider;