carbon-react/esm/components/hr/hr.component.d.ts

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

import { MarginProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags";
/**
 * @deprecated `Hr` has been deprecated. See the Carbon documentation for migration details.
 */
export interface HrProps extends MarginProps, TagProps {
    /** Set whether the component should be recognised by assistive technologies */
    "aria-hidden"?: "true" | "false";
    /** Breakpoint for adaptive left and right margins (below the breakpoint they go to 0).
     * Enables the adaptive behaviour when set */
    adaptiveMxBreakpoint?: number;
    /** Set the height of the component. Accepts one of "small", "medium", or "large" */
    height?: "small" | "medium" | "large";
    /** Set the color variant of the horizontal rule. Use "typical" for standard styling or "inverse" for use in darker backgrounds */
    type?: "typical" | "inverse";
}
/**
 * @deprecated `Hr` has been deprecated. See the Carbon documentation for migration details.
 */
export declare const Hr: ({ adaptiveMxBreakpoint, ml, mr, "aria-hidden": ariaHidden, type, height, ...rest }: HrProps) => JSX.Element;
export default Hr;