@muraldevkit/ui-toolkit 2.83.0 → 2.84.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -22,7 +22,12 @@ If you need to verify your local changes in an external project see our [Local E
22
22
 
23
23
  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)
24
24
 
25
- ## Documentation
25
+ ## Documentation
26
+ ### Usage
27
+ The source of truth for component and token documentation is at http://uitoolkit.mural.co/. Sign in with your Google account and explore.
28
+ If you have any questions or feedback, please let us know in slack `#ask-fe-platform`
29
+
30
+ ### Development
26
31
  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/storybookds_docs`. For documentation on how to write [Storybook stories](https://storybook.js.org/docs/react/writing-stories/introduction).
27
32
 
28
33
  *During deployments we remove the docs and strip comments.*
@@ -45,5 +45,5 @@ interface MrlPanelProps extends React.ComponentPropsWithRef<'div'> {
45
45
  * @param props The MrlPanel component properties.
46
46
  * @returns The MrlPanel component.
47
47
  */
48
- export declare const MrlPanel: (props: MrlPanelProps) => JSX.Element;
48
+ export declare const MrlPanel: React.ForwardRefExoticComponent<Pick<MrlPanelProps, "header" | "slot" | "style" | "title" | "dir" | "children" | "key" | "placeholder" | "id" | "defaultValue" | "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" | "description" | "data-qa" | "disableAutofocus" | "onClose" | "topActions" | "hasStickyHeader"> & React.RefAttributes<HTMLDivElement>>;
49
49
  export {};
@@ -1,4 +1,4 @@
1
- /// <reference types="react" />
1
+ import * as React from 'react';
2
2
  import { MrlTableProps } from '../MrlTable';
3
3
  import { MrlSortDirection, MrlTableColumnId, MrlTableColumnSortDescriptor, MrlTableItemId, MrlTableSelectionMode } from '../constants';
4
4
  export interface MrlSmartColumnRendererProps {
@@ -58,6 +58,11 @@ export interface MrlTableItem extends Record<string, unknown> {
58
58
  * This makes the row item visually disabled.
59
59
  */
60
60
  isDisabled?: boolean;
61
+ /**
62
+ * A ref to the table row element
63
+ * The ref is an object where the key is the item id and the value is the table row element
64
+ */
65
+ rowRef?: React.MutableRefObject<Record<MrlTableItemId, HTMLTableRowElement>>;
61
66
  }
62
67
  export type MrlTableColumnSticky = 'left' | 'right';
63
68
  export interface MrlSmartTableColumn {
@@ -7,6 +7,10 @@ export interface MrlTableRowProps extends React.ComponentPropsWithoutRef<'tr'> {
7
7
  * @default `${id}-mrl-table-row`
8
8
  */
9
9
  id?: string;
10
+ /**
11
+ * Id of the MrlTableItem associated with the table row
12
+ */
13
+ itemId?: string;
10
14
  /**
11
15
  *
12
16
  * Custom click handler to be used for mouse and keyboard selection of table row
@@ -19,4 +23,4 @@ export interface MrlTableRowProps extends React.ComponentPropsWithoutRef<'tr'> {
19
23
  * @param {MrlTableRowProps} props - MrlTableRow component props
20
24
  * @returns a table row element
21
25
  */
22
- export declare function MrlTableRow({ className, onClick, ...rest }: MrlTableRowProps): JSX.Element;
26
+ export declare const MrlTableRow: React.ForwardRefExoticComponent<MrlTableRowProps & React.RefAttributes<Record<string, HTMLTableRowElement>>>;