import { SpaceProps, TypographyProps } from 'styled-system'; import { NewColorProps as ColorProps } from '../../utils/color-props.js'; import type { VariantType } from '../../theme.js'; export type LabelVariantType = VariantType; /** * Prop Types of a Label component. * Apart from those explicitly specified below it extends all {@link ColorProps}, * {@link SpaceProps} and {@link TypographyProps} * * @memberof Label * @alias LabelProps * @property {string} [...] All props default to _label_ html component like `htmlFor`, * `id` etc. * @property {string} [...] Other props from {@link ColorProps}, {@link SpaceProps} * and {@link TypographyProps} */ export type LabelProps = ColorProps & SpaceProps & TypographyProps & { /** If label represents required field - appends star (*) */ required?: boolean; /** If label should be in uppercase version */ uppercase?: boolean; /** By default labels are displayed as a block. You can override this by setting `inline` */ inline?: boolean; /** If label represents disabled field (dimmed version) */ disabled?: boolean; /** Color variant */ variant?: LabelVariantType; /** Label size */ size?: 'default' | 'lg'; }; /** * @classdesc * * * * Styled form of **label** element. * * ### Usage * * ```javascript * import { Label, LabelProps } from '@adminjs/design-system' * ``` * * @component * @subcategory Atoms * @see LabelProps * @see {@link https://storybook.adminjs.co/?path=/story/designsystem-atoms-label--default Storybook} * @hideconstructor * @example 2 Different versions * return ( * * * * * * * * * ) * @section design-system */ declare const Label: import("styled-components").StyledComponent<"label", import("styled-components").DefaultTheme, Omit>, string | number | symbol>, "color"> & { color?: string | undefined; } & SpaceProps>, string | number | symbol> & TypographyProps>> & { /** If label represents required field - appends star (*) */ required?: boolean | undefined; /** If label should be in uppercase version */ uppercase?: boolean | undefined; /** By default labels are displayed as a block. You can override this by setting `inline` */ inline?: boolean | undefined; /** If label represents disabled field (dimmed version) */ disabled?: boolean | undefined; /** Color variant */ variant?: VariantType | undefined; /** Label size */ size?: "default" | "lg" | undefined; }, never>; export { Label }; export default Label;