@muraldevkit/ui-toolkit 2.88.0 → 2.89.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
|
@@ -18,14 +18,15 @@ To run tests locally:
|
|
|
18
18
|
- `npm run test`
|
|
19
19
|
|
|
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
22
|
## What's included
|
|
22
23
|
|
|
23
24
|
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
25
|
|
|
25
|
-
## Documentation
|
|
26
|
+
## Documentation
|
|
26
27
|
### Usage
|
|
27
28
|
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
|
+
If you have any questions or feedback, please let us know in slack `#ask-fe-platform`
|
|
29
30
|
|
|
30
31
|
### Development
|
|
31
32
|
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).
|
|
@@ -19,9 +19,13 @@ export interface MrlInlineMessageProps {
|
|
|
19
19
|
*/
|
|
20
20
|
kind: InlineMessageKind;
|
|
21
21
|
/**
|
|
22
|
-
* The text to be displayed in the notification.
|
|
22
|
+
* The text to be displayed in the notification. If not provided, children will be used.
|
|
23
23
|
*/
|
|
24
|
-
message
|
|
24
|
+
message?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Children to be rendered within the component, it will be used as the message if message is not provided.
|
|
27
|
+
*/
|
|
28
|
+
children?: React.ReactNode;
|
|
25
29
|
/**
|
|
26
30
|
* The data-qa attribute for testing purposes.
|
|
27
31
|
*/
|
|
@@ -33,4 +37,4 @@ export interface MrlInlineMessageProps {
|
|
|
33
37
|
* @param props - The properties of the component.
|
|
34
38
|
* @returns A React component.
|
|
35
39
|
*/
|
|
36
|
-
export declare const MrlInlineMessage: ({ customIcon, id, kind, message, ["data-qa"]: qa }: MrlInlineMessageProps) => React.ReactElement;
|
|
40
|
+
export declare const MrlInlineMessage: ({ children, customIcon, id, kind, message, ["data-qa"]: qa }: MrlInlineMessageProps) => React.ReactElement;
|