@norges-domstoler/dds-components 2.5.1 → 3.0.0

package/dist/types/BaseComponentProps.d.ts

@@ -0,0 +1,308 @@
+import { HTMLAttributes, PropsWithChildren } from 'react';
+/**
+ * Basetype for props som eksponeres til konsumenter av designsystemet.
+ * Lager en intersection-type med props som sendes inn og `id` og `htmlProps`
+ * slik at man kan ha `HTMLAttributes`-props på komponenter som eksponeres
+ * av designsystemet. Se også {@link BaseComponentPropsWithChildren} og
+ * {@link getBaseHTMLProps}.
+ *
+ * @template TElement Element-type som genereres av komponenten.
+ * @template TOtherProps Andre props komponenten skal eksponere til konsumenter.
+ * @template THTMLAttributesProps Standard `HTMLAttributes<T>` men kan overstyres for f.eks knapper hvis man trenger en annen basetype for `htmlProps`.
+ */
+export declare type BaseComponentProps<TElement extends Element, TOtherProps extends Record<string, unknown> = Record<string, unknown>, THTMLAttributesProps extends HTMLAttributes<TElement> = HTMLAttributes<TElement>> = {
+    /**ID til HTML-elementet som genereres. */
+    id?: THTMLAttributesProps['id'];
+    /**Ekstra HTML-attributter som vil settes på elementet som genereres. Untatt ID som settes på toppnivå. */
+    htmlProps?: Omit<THTMLAttributesProps, 'id'>;
+} & TOtherProps;
+/**
+ * Utvidelese av {@link BaseComponentProps} med prop for `children`.
+ *
+ * {@link BaseComponentProps}
+ */
+export declare type BaseComponentPropsWithChildren<T extends Element, TProps extends Record<string, unknown>, THTMLProps extends HTMLAttributes<T> = HTMLAttributes<T>> = BaseComponentProps<T, PropsWithChildren<TProps>, THTMLProps>;
+/**
+ * Slår sammen htmlProps, id, og unknownProps til ett objekt som
+ * kan spreades som baseprops for en komponent. `unknownProps` er
+ * med for å sikre at aria- og data- attributter blir spreadet, alle
+ * komponenter må derfor ta hensyn til `...rest` når de leser props.
+ *
+ * Typisk bruk:
+ * ```
+ * const Props = BaseComponentProps<HTMLElement, {
+ *   propA: string,
+ *   propB: string,
+ * }>
+ *
+ * const MyComponent = (props: Props) => {
+ *   const { propA, propB, id, htmlProps, ...rest } = props;
+ *
+ *   const wrapperProps = getBaseHTMLProps(id, htmlProps, rest)
+ *
+ *   return <div {...wrapperProps}>innhold</div>
+ * }
+ * ```
+ * @param id id fra props til komponenten.
+ * @param htmlProps htmlProps fra komponenten.
+ * @param unknownProps andre ukjente props som skal spreades, kommer typisk fra `...rest` når man leser props til komponenten.
+ * @returns Objekt med alle argumentene som kan spreades.
+ */
+export declare const getBaseHTMLProps: <T extends Element>(id: string | undefined, htmlProps: Omit<HTMLAttributes<T>, "id"> | undefined, unknownProps: object) => {
+    id: string | undefined;
+    defaultChecked?: boolean | undefined;
+    defaultValue?: string | number | readonly string[] | undefined;
+    suppressContentEditableWarning?: boolean | undefined;
+    suppressHydrationWarning?: boolean | undefined;
+    accessKey?: string | undefined;
+    className?: string | undefined;
+    contentEditable?: (boolean | "true" | "false") | "inherit" | undefined;
+    contextMenu?: string | undefined;
+    dir?: string | undefined;
+    draggable?: (boolean | "true" | "false") | undefined;
+    hidden?: boolean | undefined;
+    lang?: string | undefined;
+    placeholder?: string | undefined;
+    slot?: string | undefined;
+    spellCheck?: (boolean | "true" | "false") | undefined;
+    style?: import("react").CSSProperties | undefined;
+    tabIndex?: number | undefined;
+    title?: string | undefined;
+    translate?: "yes" | "no" | undefined;
+    radioGroup?: string | undefined;
+    role?: import("react").AriaRole | undefined;
+    about?: string | undefined;
+    datatype?: string | undefined;
+    inlist?: any;
+    prefix?: string | undefined;
+    property?: string | undefined;
+    resource?: string | undefined;
+    typeof?: string | undefined;
+    vocab?: string | undefined;
+    autoCapitalize?: string | undefined;
+    autoCorrect?: string | undefined;
+    autoSave?: string | undefined;
+    color?: string | undefined;
+    itemProp?: string | undefined;
+    itemScope?: boolean | undefined;
+    itemType?: string | undefined;
+    itemID?: string | undefined;
+    itemRef?: string | undefined;
+    results?: number | undefined;
+    security?: string | undefined;
+    unselectable?: "on" | "off" | undefined;
+    inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
+    is?: string | undefined;
+    'aria-activedescendant'?: string | undefined;
+    'aria-atomic'?: (boolean | "true" | "false") | undefined;
+    'aria-autocomplete'?: "list" | "none" | "inline" | "both" | undefined;
+    'aria-busy'?: (boolean | "true" | "false") | undefined;
+    'aria-checked'?: boolean | "true" | "false" | "mixed" | undefined;
+    'aria-colcount'?: number | undefined;
+    'aria-colindex'?: number | undefined;
+    'aria-colspan'?: number | undefined;
+    'aria-controls'?: string | undefined;
+    'aria-current'?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time" | undefined;
+    'aria-describedby'?: string | undefined;
+    'aria-details'?: string | undefined;
+    'aria-disabled'?: (boolean | "true" | "false") | undefined;
+    'aria-dropeffect'?: "link" | "none" | "copy" | "execute" | "move" | "popup" | undefined;
+    'aria-errormessage'?: string | undefined;
+    'aria-expanded'?: (boolean | "true" | "false") | undefined;
+    'aria-flowto'?: string | undefined;
+    'aria-grabbed'?: (boolean | "true" | "false") | undefined;
+    'aria-haspopup'?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree" | undefined;
+    'aria-hidden'?: (boolean | "true" | "false") | undefined;
+    'aria-invalid'?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
+    'aria-keyshortcuts'?: string | undefined;
+    'aria-label'?: string | undefined;
+    'aria-labelledby'?: string | undefined;
+    'aria-level'?: number | undefined;
+    'aria-live'?: "off" | "assertive" | "polite" | undefined;
+    'aria-modal'?: (boolean | "true" | "false") | undefined;
+    'aria-multiline'?: (boolean | "true" | "false") | undefined;
+    'aria-multiselectable'?: (boolean | "true" | "false") | undefined;
+    'aria-orientation'?: "horizontal" | "vertical" | undefined;
+    'aria-owns'?: string | undefined;
+    'aria-placeholder'?: string | undefined;
+    'aria-posinset'?: number | undefined;
+    'aria-pressed'?: boolean | "true" | "false" | "mixed" | undefined;
+    'aria-readonly'?: (boolean | "true" | "false") | undefined;
+    'aria-relevant'?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
+    'aria-required'?: (boolean | "true" | "false") | undefined;
+    'aria-roledescription'?: string | undefined;
+    'aria-rowcount'?: number | undefined;
+    'aria-rowindex'?: number | undefined;
+    'aria-rowspan'?: number | undefined;
+    'aria-selected'?: (boolean | "true" | "false") | undefined;
+    'aria-setsize'?: number | undefined;
+    'aria-sort'?: "none" | "ascending" | "descending" | "other" | undefined;
+    'aria-valuemax'?: number | undefined;
+    'aria-valuemin'?: number | undefined;
+    'aria-valuenow'?: number | undefined;
+    'aria-valuetext'?: string | undefined;
+    children?: import("react").ReactNode;
+    dangerouslySetInnerHTML?: {
+        __html: string;
+    } | undefined;
+    onCopy?: import("react").ClipboardEventHandler<T> | undefined;
+    onCopyCapture?: import("react").ClipboardEventHandler<T> | undefined;
+    onCut?: import("react").ClipboardEventHandler<T> | undefined;
+    onCutCapture?: import("react").ClipboardEventHandler<T> | undefined;
+    onPaste?: import("react").ClipboardEventHandler<T> | undefined;
+    onPasteCapture?: import("react").ClipboardEventHandler<T> | undefined;
+    onCompositionEnd?: import("react").CompositionEventHandler<T> | undefined;
+    onCompositionEndCapture?: import("react").CompositionEventHandler<T> | undefined;
+    onCompositionStart?: import("react").CompositionEventHandler<T> | undefined;
+    onCompositionStartCapture?: import("react").CompositionEventHandler<T> | undefined;
+    onCompositionUpdate?: import("react").CompositionEventHandler<T> | undefined;
+    onCompositionUpdateCapture?: import("react").CompositionEventHandler<T> | undefined;
+    onFocus?: import("react").FocusEventHandler<T> | undefined;
+    onFocusCapture?: import("react").FocusEventHandler<T> | undefined;
+    onBlur?: import("react").FocusEventHandler<T> | undefined;
+    onBlurCapture?: import("react").FocusEventHandler<T> | undefined;
+    onChange?: import("react").FormEventHandler<T> | undefined;
+    onChangeCapture?: import("react").FormEventHandler<T> | undefined;
+    onBeforeInput?: import("react").FormEventHandler<T> | undefined;
+    onBeforeInputCapture?: import("react").FormEventHandler<T> | undefined;
+    onInput?: import("react").FormEventHandler<T> | undefined;
+    onInputCapture?: import("react").FormEventHandler<T> | undefined;
+    onReset?: import("react").FormEventHandler<T> | undefined;
+    onResetCapture?: import("react").FormEventHandler<T> | undefined;
+    onSubmit?: import("react").FormEventHandler<T> | undefined;
+    onSubmitCapture?: import("react").FormEventHandler<T> | undefined;
+    onInvalid?: import("react").FormEventHandler<T> | undefined;
+    onInvalidCapture?: import("react").FormEventHandler<T> | undefined;
+    onLoad?: import("react").ReactEventHandler<T> | undefined;
+    onLoadCapture?: import("react").ReactEventHandler<T> | undefined;
+    onError?: import("react").ReactEventHandler<T> | undefined;
+    onErrorCapture?: import("react").ReactEventHandler<T> | undefined;
+    onKeyDown?: import("react").KeyboardEventHandler<T> | undefined;
+    onKeyDownCapture?: import("react").KeyboardEventHandler<T> | undefined;
+    onKeyPress?: import("react").KeyboardEventHandler<T> | undefined;
+    onKeyPressCapture?: import("react").KeyboardEventHandler<T> | undefined;
+    onKeyUp?: import("react").KeyboardEventHandler<T> | undefined;
+    onKeyUpCapture?: import("react").KeyboardEventHandler<T> | undefined;
+    onAbort?: import("react").ReactEventHandler<T> | undefined;
+    onAbortCapture?: import("react").ReactEventHandler<T> | undefined;
+    onCanPlay?: import("react").ReactEventHandler<T> | undefined;
+    onCanPlayCapture?: import("react").ReactEventHandler<T> | undefined;
+    onCanPlayThrough?: import("react").ReactEventHandler<T> | undefined;
+    onCanPlayThroughCapture?: import("react").ReactEventHandler<T> | undefined;
+    onDurationChange?: import("react").ReactEventHandler<T> | undefined;
+    onDurationChangeCapture?: import("react").ReactEventHandler<T> | undefined;
+    onEmptied?: import("react").ReactEventHandler<T> | undefined;
+    onEmptiedCapture?: import("react").ReactEventHandler<T> | undefined;
+    onEncrypted?: import("react").ReactEventHandler<T> | undefined;
+    onEncryptedCapture?: import("react").ReactEventHandler<T> | undefined;
+    onEnded?: import("react").ReactEventHandler<T> | undefined;
+    onEndedCapture?: import("react").ReactEventHandler<T> | undefined;
+    onLoadedData?: import("react").ReactEventHandler<T> | undefined;
+    onLoadedDataCapture?: import("react").ReactEventHandler<T> | undefined;
+    onLoadedMetadata?: import("react").ReactEventHandler<T> | undefined;
+    onLoadedMetadataCapture?: import("react").ReactEventHandler<T> | undefined;
+    onLoadStart?: import("react").ReactEventHandler<T> | undefined;
+    onLoadStartCapture?: import("react").ReactEventHandler<T> | undefined;
+    onPause?: import("react").ReactEventHandler<T> | undefined;
+    onPauseCapture?: import("react").ReactEventHandler<T> | undefined;
+    onPlay?: import("react").ReactEventHandler<T> | undefined;
+    onPlayCapture?: import("react").ReactEventHandler<T> | undefined;
+    onPlaying?: import("react").ReactEventHandler<T> | undefined;
+    onPlayingCapture?: import("react").ReactEventHandler<T> | undefined;
+    onProgress?: import("react").ReactEventHandler<T> | undefined;
+    onProgressCapture?: import("react").ReactEventHandler<T> | undefined;
+    onRateChange?: import("react").ReactEventHandler<T> | undefined;
+    onRateChangeCapture?: import("react").ReactEventHandler<T> | undefined;
+    onSeeked?: import("react").ReactEventHandler<T> | undefined;
+    onSeekedCapture?: import("react").ReactEventHandler<T> | undefined;
+    onSeeking?: import("react").ReactEventHandler<T> | undefined;
+    onSeekingCapture?: import("react").ReactEventHandler<T> | undefined;
+    onStalled?: import("react").ReactEventHandler<T> | undefined;
+    onStalledCapture?: import("react").ReactEventHandler<T> | undefined;
+    onSuspend?: import("react").ReactEventHandler<T> | undefined;
+    onSuspendCapture?: import("react").ReactEventHandler<T> | undefined;
+    onTimeUpdate?: import("react").ReactEventHandler<T> | undefined;
+    onTimeUpdateCapture?: import("react").ReactEventHandler<T> | undefined;
+    onVolumeChange?: import("react").ReactEventHandler<T> | undefined;
+    onVolumeChangeCapture?: import("react").ReactEventHandler<T> | undefined;
+    onWaiting?: import("react").ReactEventHandler<T> | undefined;
+    onWaitingCapture?: import("react").ReactEventHandler<T> | undefined;
+    onAuxClick?: import("react").MouseEventHandler<T> | undefined;
+    onAuxClickCapture?: import("react").MouseEventHandler<T> | undefined;
+    onClick?: import("react").MouseEventHandler<T> | undefined;
+    onClickCapture?: import("react").MouseEventHandler<T> | undefined;
+    onContextMenu?: import("react").MouseEventHandler<T> | undefined;
+    onContextMenuCapture?: import("react").MouseEventHandler<T> | undefined;
+    onDoubleClick?: import("react").MouseEventHandler<T> | undefined;
+    onDoubleClickCapture?: import("react").MouseEventHandler<T> | undefined;
+    onDrag?: import("react").DragEventHandler<T> | undefined;
+    onDragCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragEnd?: import("react").DragEventHandler<T> | undefined;
+    onDragEndCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragEnter?: import("react").DragEventHandler<T> | undefined;
+    onDragEnterCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragExit?: import("react").DragEventHandler<T> | undefined;
+    onDragExitCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragLeave?: import("react").DragEventHandler<T> | undefined;
+    onDragLeaveCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragOver?: import("react").DragEventHandler<T> | undefined;
+    onDragOverCapture?: import("react").DragEventHandler<T> | undefined;
+    onDragStart?: import("react").DragEventHandler<T> | undefined;
+    onDragStartCapture?: import("react").DragEventHandler<T> | undefined;
+    onDrop?: import("react").DragEventHandler<T> | undefined;
+    onDropCapture?: import("react").DragEventHandler<T> | undefined;
+    onMouseDown?: import("react").MouseEventHandler<T> | undefined;
+    onMouseDownCapture?: import("react").MouseEventHandler<T> | undefined;
+    onMouseEnter?: import("react").MouseEventHandler<T> | undefined;
+    onMouseLeave?: import("react").MouseEventHandler<T> | undefined;
+    onMouseMove?: import("react").MouseEventHandler<T> | undefined;
+    onMouseMoveCapture?: import("react").MouseEventHandler<T> | undefined;
+    onMouseOut?: import("react").MouseEventHandler<T> | undefined;
+    onMouseOutCapture?: import("react").MouseEventHandler<T> | undefined;
+    onMouseOver?: import("react").MouseEventHandler<T> | undefined;
+    onMouseOverCapture?: import("react").MouseEventHandler<T> | undefined;
+    onMouseUp?: import("react").MouseEventHandler<T> | undefined;
+    onMouseUpCapture?: import("react").MouseEventHandler<T> | undefined;
+    onSelect?: import("react").ReactEventHandler<T> | undefined;
+    onSelectCapture?: import("react").ReactEventHandler<T> | undefined;
+    onTouchCancel?: import("react").TouchEventHandler<T> | undefined;
+    onTouchCancelCapture?: import("react").TouchEventHandler<T> | undefined;
+    onTouchEnd?: import("react").TouchEventHandler<T> | undefined;
+    onTouchEndCapture?: import("react").TouchEventHandler<T> | undefined;
+    onTouchMove?: import("react").TouchEventHandler<T> | undefined;
+    onTouchMoveCapture?: import("react").TouchEventHandler<T> | undefined;
+    onTouchStart?: import("react").TouchEventHandler<T> | undefined;
+    onTouchStartCapture?: import("react").TouchEventHandler<T> | undefined;
+    onPointerDown?: import("react").PointerEventHandler<T> | undefined;
+    onPointerDownCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerMove?: import("react").PointerEventHandler<T> | undefined;
+    onPointerMoveCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerUp?: import("react").PointerEventHandler<T> | undefined;
+    onPointerUpCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerCancel?: import("react").PointerEventHandler<T> | undefined;
+    onPointerCancelCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerEnter?: import("react").PointerEventHandler<T> | undefined;
+    onPointerEnterCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerLeave?: import("react").PointerEventHandler<T> | undefined;
+    onPointerLeaveCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerOver?: import("react").PointerEventHandler<T> | undefined;
+    onPointerOverCapture?: import("react").PointerEventHandler<T> | undefined;
+    onPointerOut?: import("react").PointerEventHandler<T> | undefined;
+    onPointerOutCapture?: import("react").PointerEventHandler<T> | undefined;
+    onGotPointerCapture?: import("react").PointerEventHandler<T> | undefined;
+    onGotPointerCaptureCapture?: import("react").PointerEventHandler<T> | undefined;
+    onLostPointerCapture?: import("react").PointerEventHandler<T> | undefined;
+    onLostPointerCaptureCapture?: import("react").PointerEventHandler<T> | undefined;
+    onScroll?: import("react").UIEventHandler<T> | undefined;
+    onScrollCapture?: import("react").UIEventHandler<T> | undefined;
+    onWheel?: import("react").WheelEventHandler<T> | undefined;
+    onWheelCapture?: import("react").WheelEventHandler<T> | undefined;
+    onAnimationStart?: import("react").AnimationEventHandler<T> | undefined;
+    onAnimationStartCapture?: import("react").AnimationEventHandler<T> | undefined;
+    onAnimationEnd?: import("react").AnimationEventHandler<T> | undefined;
+    onAnimationEndCapture?: import("react").AnimationEventHandler<T> | undefined;
+    onAnimationIteration?: import("react").AnimationEventHandler<T> | undefined;
+    onAnimationIterationCapture?: import("react").AnimationEventHandler<T> | undefined;
+    onTransitionEnd?: import("react").TransitionEventHandler<T> | undefined;
+    onTransitionEndCapture?: import("react").TransitionEventHandler<T> | undefined;
+};

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from './Direction';
+export * from './BaseComponentProps';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@norges-domstoler/dds-components",
-  "version": "2.5.1",
+  "version": "3.0.0",
   "description": "React components used in Elsa - domstolenes designsystem",
   "author": "Elsa team",
   "license": "MIT",
@@ -22,7 +22,8 @@
     "storybook": "start-storybook -p 6006 -s ./.storybook/images",
     "build-storybook": "build-storybook -o docs",
     "lint": "eslint --ext=jsx,ts,tsx src",
-    "prettier": "prettier --write '**/*.{ts,tsx}'"
+    "prettier": "prettier --write '**/*.{ts,tsx}'",
+    "check:types": "tsc --noEmit"
   },
   "keywords": [
     "dds",