UNPKG

@metamask/design-system-react

Version:
1 lines 1.52 kB
{"version":3,"file":"BadgeStatus.types.cjs","sourceRoot":"","sources":["../../../src/components/BadgeStatus/BadgeStatus.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentProps } from 'react';\n\nimport type { BadgeStatusSize, BadgeStatusStatus } from '../../types';\n\n/**\n * BadgeStatus component props.\n */\nexport type BadgeStatusProps = ComponentProps<'div'> & {\n /**\n * Optional prop to control the status of the badge\n * Possible values:\n * - BadgeStatusStatus.Active. (Connected)\n * - BadgeStatusStatus.Inactive. (Connected)\n * - BadgeStatusStatus.Disconnected.\n * - BadgeStatusStatus.New.\n * - BadgeStatusStatus.Attention.\n */\n status: BadgeStatusStatus;\n /**\n * Optional prop to determine whether the badge should display a border\n *\n * @default true\n */\n hasBorder?: boolean;\n /**\n * Optional prop to control the size of the BadgeStatus\n * Possible values:\n * - BadgeStatusSize.Md (8px),\n * - BadgeStatusSize.Lg (10px),\n *\n * @default AvatarBaseSize.Md\n */\n size?: BadgeStatusSize;\n /**\n * Optional prop for additional CSS classes to be applied to the BadgeStatus component.\n * These classes will be merged with the component's default classes using twMerge.\n */\n className?: string;\n /**\n * Optional CSS styles to be applied to the component.\n * Should be used sparingly and only for dynamic styles that can't be achieved with className.\n */\n style?: React.CSSProperties;\n};\n"]}