@workday/canvas-kit-preview-react/dist/commonjs/divider/lib/Divider.d.ts

Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.

import { CSProps } from '@workday/canvas-kit-styling';
export declare const dividerStencil: import("@workday/canvas-kit-styling").Stencil<import("@workday/canvas-kit-styling").StencilModifierConfig<{
    space: string;
}, never>, {
    space: string;
}, never, never>;
export interface DividerProps extends CSProps {
    /**
     * Applies top and bottom margin evenly. It divides the provided value by two and applies half to each end.
     * E.g. `space="2rem"` would apply `1rem` margin to the top, and `1rem` margin to the bottom.
     * @default `system.space.x4` (1rem)
     */
    space?: string;
}
/**
 * # Divider
 * A divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.
 *
 * [View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider-react)
 *
 * The `space` prop will equally apply top and bottom margin styles.
 * In the example below, `x2` (0.5rem), adds `0.25rem` margin to the top and `0.25rem` to the bottom
 *
 * @example
 * ```tsx
 * import { Divider } from '@workday/canvas-kit-preview-react/divider';
 * import {system} from '@workday/canvas-tokens-web';
 *
 * <Divider space={system.space.x2} />
 *
 * ```
 */
export declare const Divider: import("@workday/canvas-kit-react/common").ElementComponent<"hr", DividerProps>;
//# sourceMappingURL=Divider.d.ts.map