From c52ab270e412f64c59209d415c450e7ddfba1b07 Mon Sep 17 00:00:00 2001 From: Barsnes Date: Wed, 22 Jan 2025 08:37:42 +0100 Subject: [PATCH 01/10] chore: go over react props and jsdoc --- packages/react/src/components/Alert/Alert.tsx | 6 ++++-- packages/react/src/components/Badge/Badge.tsx | 11 +--------- .../src/components/Badge/BadgePosition.tsx | 9 ++++++++ .../components/Breadcrumbs/Breadcrumbs.tsx | 18 ++++++++++++++++ .../react/src/components/Button/Button.tsx | 7 +++++-- packages/react/src/components/Card/Card.tsx | 5 +++++ .../src/components/Checkbox/Checkbox.tsx | 21 ++++++++++++++----- packages/react/src/components/Chip/Chips.tsx | 1 + .../react/src/components/Details/Details.tsx | 13 ++++++++---- .../src/components/Details/DetailsContent.tsx | 1 + .../src/components/Details/DetailsSummary.tsx | 1 + .../react/src/components/Divider/Divider.tsx | 6 ++++++ .../src/components/Dropdown/Dropdown.tsx | 19 ++++++++++++++++- .../Dropdown/DropdownTriggerContext.tsx | 5 ++++- .../components/ErrorSummary/ErrorSummary.tsx | 12 +++++++++++ 15 files changed, 110 insertions(+), 25 deletions(-) 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/Badge/Badge.tsx b/packages/react/src/components/Badge/Badge.tsx index 94c40e8eb4..4684733f88 100644 --- a/packages/react/src/components/Badge/Badge.tsx +++ b/packages/react/src/components/Badge/Badge.tsx @@ -22,16 +22,7 @@ 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/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) => (