diff --git a/.changeset/popular-tools-impress.md b/.changeset/popular-tools-impress.md new file mode 100644 index 0000000000..c0bca17180 --- /dev/null +++ b/.changeset/popular-tools-impress.md @@ -0,0 +1,5 @@ +--- +"@digdir/designsystemet-react": minor +--- + +**Checkbox**: Rename `validation` to `error` diff --git a/.changeset/ten-mirrors-pretend.md b/.changeset/ten-mirrors-pretend.md new file mode 100644 index 0000000000..bb0a60fc67 --- /dev/null +++ b/.changeset/ten-mirrors-pretend.md @@ -0,0 +1,5 @@ +--- +"@digdir/designsystemet-react": minor +--- + +**Radio**: Rename `validation` to `error` diff --git a/packages/react/src/components/Alert/Alert.tsx b/packages/react/src/components/Alert/Alert.tsx index dff041e60e..d9bb257a25 100644 --- a/packages/react/src/components/Alert/Alert.tsx +++ b/packages/react/src/components/Alert/Alert.tsx @@ -10,7 +10,8 @@ export type AlertProps = MergeRight< { /** * Sets color and icon. - * @default info + * + * @default 'info' */ 'data-color'?: SeverityColors; } @@ -18,8 +19,9 @@ export type AlertProps = MergeRight< /** * Alerts are used to inform users about important information, warnings, errors, or success. + * * @example - * Dette er en informasjonsmelding + * Dette er en informasjonsmelding */ export const Alert = forwardRef(function Alert( { 'data-color': color = 'info', className, ...rest }, diff --git a/packages/react/src/components/Alert/index.ts b/packages/react/src/components/Alert/index.ts index 79e3b155f4..7a4601fadc 100644 --- a/packages/react/src/components/Alert/index.ts +++ b/packages/react/src/components/Alert/index.ts @@ -1 +1,2 @@ -export * from './Alert'; +export { Alert } from './Alert'; +export type { AlertProps } from './Alert'; diff --git a/packages/react/src/components/Badge/Badge.tsx b/packages/react/src/components/Badge/Badge.tsx index 94c40e8eb4..686ba27cba 100644 --- a/packages/react/src/components/Badge/Badge.tsx +++ b/packages/react/src/components/Badge/Badge.tsx @@ -22,16 +22,12 @@ export type BadgeProps = MergeRight< * `Badge` is a non-interactive component for displaying status with or without numbers. * * @example without children - * ```jsx - * - * ``` + * * * @example with children - * ```jsx - * - * + * + * * - * ``` */ export const Badge = forwardRef(function Badge( { className, count, maxCount, ...rest }, diff --git a/packages/react/src/components/Badge/BadgePosition.tsx b/packages/react/src/components/Badge/BadgePosition.tsx index 240312c1a3..10cc5daf24 100644 --- a/packages/react/src/components/Badge/BadgePosition.tsx +++ b/packages/react/src/components/Badge/BadgePosition.tsx @@ -20,6 +20,15 @@ export type BadgePositionProps = MergeRight< } >; +/** + * `BadgePosition` is a component that positions the badge. + * + * @example + * + * + * + * + */ export const BadgePosition = forwardRef( function BadgePlacement( { className, overlap = 'rectangle', placement = 'top-right', ...rest }, diff --git a/packages/react/src/components/Badge/index.ts b/packages/react/src/components/Badge/index.ts index d9de42fc92..2de9a281f4 100644 --- a/packages/react/src/components/Badge/index.ts +++ b/packages/react/src/components/Badge/index.ts @@ -1,6 +1,12 @@ import { Badge as BadgeElm } from './Badge'; import { BadgePosition } from './BadgePosition'; +/** + * `Badge` is a non-interactive component for displaying status with or without numbers. + * + * @example without children + * + */ const Badge = Object.assign(BadgeElm, { Position: BadgePosition }); Badge.Position.displayName = 'Badge.Position'; diff --git a/packages/react/src/components/Breadcrumbs/Breadcrumbs.tsx b/packages/react/src/components/Breadcrumbs/Breadcrumbs.tsx index cebbe8b570..717de010b5 100644 --- a/packages/react/src/components/Breadcrumbs/Breadcrumbs.tsx +++ b/packages/react/src/components/Breadcrumbs/Breadcrumbs.tsx @@ -14,6 +14,24 @@ export type BreadcrumbsProps = MergeRight< } >; +/** + * `Breadcrumbs` is a component that displays a list of breadcrumbs. + * + * @example + * + * + * Nivå 1 + * + * + * + * Nivå 1 + * + * + * Nivå 2 + * + * + * + */ export const Breadcrumbs = forwardRef( ({ 'aria-label': ariaLabel = 'Du er her:', className, ...rest }, ref) => (