UNPKG

carbon-react

Version:

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

28 lines (27 loc) 1.06 kB
import React from "react"; import { type CSSProperties } from "styled-components"; import { type TagProps } from "../../../__internal__/utils/helpers/tags"; import { IconProps } from "../../icon"; export interface OptionGroupHeaderProps extends TagProps { /** * Unique identifier for the component. * Will use a randomly generated GUID if none is provided. */ id?: string; /** Heading text */ label?: string; /** Any valid Carbon icon name */ icon?: IconProps["type"]; /** * @private * @ignore * object containing CSS styles to be passed to the underlying DOM element */ style?: CSSProperties; /** * Content to be rendered inside the OptionGroupHeader. * When the `children` prop is passed it will take precedence over the `label` and * `icon` props meaning they will not be rendered */ children?: React.ReactNode; } declare const OptionGroupHeader: React.ForwardRefExoticComponent<OptionGroupHeaderProps & React.RefAttributes<HTMLDivElement>>; export default OptionGroupHeader;