@muraldevkit/ui-toolkit 2.42.0 → 2.43.1

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
@@ -4,7 +4,7 @@ Shared React components for use across the Mural platform.
4
4
  ## Table of contents
5
5
  - [Quick start](#quick-start)
6
6
  - [Documentation](#documentation)
7
- - [Component standards](./docs/component-standards.md)
7
+ - [Component standards](./src/storybook_docs/getting-started/component-standards.mdx)
8
8
  - [Contribution Guide](./CONTRIBUTING.md)
9
9
  ## Quick start
10
10
 
@@ -20,7 +20,7 @@ To run tests locally:
20
20
  If you need to verify your local changes in an external project see our [Local Enviroment Guide](./docs/local-development.md).
21
21
  ## What's included
22
22
 
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](./docs/component-standards.md).
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
25
  ## Documentation
26
26
  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).
@@ -7,6 +7,8 @@ import './MrlIconButton.scss';
7
7
  export interface MrlIconButtonProps extends Omit<MrlComponentProps, 'style'>, React.ComponentProps<'button'> {
8
8
  /**
9
9
  * Applies additional HTML attributes to the button element.
10
+ *
11
+ * @deprecated
10
12
  */
11
13
  attrs?: AttrsObject;
12
14
  /**
@@ -1,7 +1,7 @@
1
1
  import * as React from 'react';
2
2
  import { LinkColor, LinkKind, LinkSize, LinkTargetType } from '../constants';
3
3
  import { AttrsObject } from '../../../utils';
4
- export interface MrlLinkProptypes {
4
+ export interface MrlLinkProptypes extends React.ComponentProps<'a'> {
5
5
  /** The textual label describing the link's purpose */
6
6
  text: string;
7
7
  /** Specifies where to redirect the linked document */
@@ -46,4 +46,4 @@ export interface MrlLinkProptypes {
46
46
  * @param {MrlLinkProptypes} props the props for your MrlLink
47
47
  * @returns {React.ReactElement} an a element containing the text you pass
48
48
  */
49
- export declare const MrlLink: ({ target, className, color, kind, size, href, attrs, onClick, text }: MrlLinkProptypes) => React.ReactElement;
49
+ export declare const MrlLink: ({ target, className, color, kind, size, href, attrs, onClick, text, ...remainingProps }: MrlLinkProptypes) => React.ReactElement;
@@ -1,6 +1,6 @@
1
1
  import React from 'react';
2
2
  import { DSIconType } from '../../../';
3
- interface MrlMenuItemLinkProps {
3
+ export interface MrlMenuItemLinkProps {
4
4
  /** ID for associated description */
5
5
  ariaDescribedBy?: string;
6
6
  /**
@@ -35,4 +35,3 @@ interface MrlMenuItemLinkProps {
35
35
  * @returns {Element} - rendered MrlMenuItem component
36
36
  */
37
37
  export declare function MrlMenuItemLink({ ariaDescribedBy, children, className, dataQa, disabled, href, icon, id, onClick, selected, target }: MrlMenuItemLinkProps): JSX.Element;
38
- export {};
@@ -1,6 +1,7 @@
1
1
  import React from 'react';
2
- export interface PortalProps {
2
+ export interface PortalProps extends React.HTMLAttributes<HTMLDivElement> {
3
3
  children: React.ReactNode;
4
+ className?: string;
4
5
  id?: string;
5
6
  }
6
7
  export declare const MRL_PORTAL_ID = "mrl-root-portal";
@@ -11,4 +12,4 @@ export declare const MRL_PORTAL_ID = "mrl-root-portal";
11
12
  * @param PortalProps Portal only takes children. Contact the platform team if you need to extend this.
12
13
  * @returns MrlPortal component
13
14
  */
14
- export declare const MrlPortal: ({ children, id }: PortalProps) => React.ReactElement | null;
15
+ export declare const MrlPortal: ({ children, className, id, ...remainingProps }: PortalProps) => React.ReactElement | null;
@@ -115,7 +115,7 @@ export declare const colorPictoStoryData: {
115
115
  export declare const animateStoryData: {
116
116
  args: {
117
117
  delay: number;
118
- state: "play" | "stop";
118
+ state: "stop" | "play";
119
119
  };
120
120
  argTypes: {
121
121
  delay: {
@@ -20,8 +20,18 @@ interface MrlTooltipProps {
20
20
  * are passed in the component will not have event handling for the additional child elements.
21
21
  */
22
22
  children: React.ReactElement;
23
+ /** Whether the tooltip should close when clicked */
24
+ clickToClose?: boolean;
23
25
  /** The data-qa attribute for the tooltip */
24
26
  dataQa?: string;
27
+ /**
28
+ * Whether to disable the screen reader text
29
+ *
30
+ * !!! only use this prop if you are sure that the tooltip content is not needed for screen reader users !!!
31
+ */
32
+ disableScreenReaderText?: boolean;
33
+ /** Whether to disable the tooltip hover action that keeps it open */
34
+ disableTooltipHover?: boolean;
25
35
  /** The kind of tooltip to be rendered */
26
36
  kind?: MrlTooltipVariant;
27
37
  /** The placement of the tooltip in relation to its trigger */
@@ -40,5 +50,8 @@ Pointing devices that can hover, but for which doing so is inconvenient and not
40
50
  * @param {MrlTooltipProps} props - The props of the component
41
51
  * @returns {HTMLElement} a configured Tooltip component
42
52
  */
43
- export declare const MrlTooltip: (props: MrlTooltipProps) => ReactElement;
53
+ export declare const MrlTooltip: {
54
+ (props: MrlTooltipProps): ReactElement;
55
+ displayName: string;
56
+ };
44
57
  export {};