@muraldevkit/ui-toolkit 4.18.0 → 4.20.0

package/README.md

@@ -1,11 +1,14 @@
 # Mural's UI Toolkit
+
 Shared React components for use across the Mural platform.
 
 ## Table of contents
+
 - [Quick start](#quick-start)
 - [Documentation](#documentation)
 - [Component standards](./src/storybook_docs/getting-started/component-standards.mdx)
 - [Contribution Guide](./CONTRIBUTING.md)
+
 ## Quick start
 
 We use Storybook as both a living documentation site and dev environment. To get started:
@@ -15,6 +18,7 @@ We use Storybook as both a living documentation site and dev environment. To get
 - `npm run dev`
 
 To run tests locally:
+
 - `npm run test`
 
 If you need to verify your local changes in an external project see our [Local Environment Guide](./docs/local-development.md).
@@ -24,14 +28,14 @@ If you need to verify your local changes in an external project see our [Local E
 Within the project you'll find the `src/` directory, which logically groups components together. For more information on our components see our [Component standards](./src/storybook_docs/getting-started/component-standards.mdx)
 
 ## Documentation
+
 ### Usage
+
 The source of truth for component and token documentation is at http://uitoolkit.mural.co/. Sign in with your Google account and explore.
 If you have any questions or feedback, please let us know in slack `#ask-fe-platform`
 
 ### Development
-Our doc site uses Storybook as living documentation and dev environment. We support [mdx](https://mdxjs.com/) files and standard Storybook files, we use [CSF version 3](https://storybook.js.org/blog/component-story-format-3-0/). You can find examples on how to add markdown docs to the doc section of our site in the `src/storybook_docs`. For documentation on how to write [Storybook stories](https://storybook.js.org/docs/react/writing-stories/introduction).
-
-*During deployments we remove the docs and strip comments.*
-
 
+Our doc site uses Storybook as living documentation and dev environment. We support [mdx](https://mdxjs.com/) files and standard Storybook files, we use [CSF version 3](https://storybook.js.org/blog/component-story-format-3-0/). You can find examples on how to add markdown docs to the doc section of our site in the `src/storybook_docs`. For documentation on how to write [Storybook stories](https://storybook.js.org/docs/react/writing-stories/introduction).
 
+_During deployments we remove the docs and strip comments._

package/dist/components/divider/constants.d.ts

@@ -1,7 +1,7 @@
 export declare const allowedValues: {
     kinds: readonly ["default", "inverse"];
     orientations: readonly ["horizontal", "vertical"];
-    spacings: readonly ["small", "medium", "large"];
+    spacings: readonly ["small", "medium", "large", "xlarge"];
 };
 export type Kind = (typeof allowedValues.kinds)[number];
 export type Orientation = (typeof allowedValues.orientations)[number];

package/dist/components/form/date-picker/MrlDatePicker.d.ts

@@ -0,0 +1,29 @@
+import * as React from 'react';
+import { InputStates } from '../constants';
+import { DataQa } from '../../../utils/dataQa';
+export interface MrlDatePickerProps extends React.ComponentPropsWithRef<'input'>, DataQa {
+    /** Id of the text input */
+    inputId: string;
+    /** The value of the text input used to make it a controlled input */
+    value?: string;
+    /**
+     * Changes the state of the input based on user permissions or actions.
+     */
+    state?: InputStates;
+    autofocus?: boolean;
+    /**
+     * Event handler for onChange Events
+     * The value is normalized to yyyy-mm-dd
+     *
+     * @link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/date
+     */
+    onChange?: React.ComponentPropsWithRef<'input'>['onChange'];
+}
+/**
+ * Allows the user to input a date
+ *
+ * @param {MrlDatePickerProps} props - the component props
+ * @param {HTMLInputElement} ref - a ref to the input element in the DOM
+ * @returns a date input element
+ */
+export declare const MrlDatePicker: React.ForwardRefExoticComponent<Pick<MrlDatePickerProps, "form" | "slot" | "style" | "title" | "pattern" | "dir" | "name" | "height" | "width" | "children" | "disabled" | "checked" | "placeholder" | "id" | "defaultValue" | "state" | "value" | "size" | "defaultChecked" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "className" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "lang" | "spellCheck" | "tabIndex" | "inputMode" | "is" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClick" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEnd" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "max" | "min" | "type" | "key" | "multiple" | "data-qa" | "list" | "step" | "alt" | "src" | "autoFocus" | "formAction" | "formEncType" | "formMethod" | "formNoValidate" | "formTarget" | "accept" | "autoComplete" | "capture" | "crossOrigin" | "maxLength" | "minLength" | "readOnly" | "required" | "inputId" | "autofocus"> & React.RefAttributes<HTMLInputElement>>;

package/dist/components/form/date-picker/index.d.ts

@@ -0,0 +1 @@
+export * from './MrlDatePicker';

package/dist/components/form/hooks/useActiveColor.d.ts

@@ -4,9 +4,9 @@ type useActiveColorReturn = {
     setHasActiveColor: (hasActiveColor: boolean) => void;
 };
 /**
- * Custom hook used to track the active color state of the text input
+ * Custom hook used to track the active color state of inputs
  *
- * @param {InputStates | undefined} state - the text input state
+ * @param {InputStates | undefined} state - the input state
  * @returns the hasActiveColor state and handler
  */
 export declare function useActiveColor(state?: InputStates): useActiveColorReturn;