@hitachivantara/uikit-react-core 3.67.13 → 3.67.16

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.
@@ -3,6 +3,9 @@ import { StandardProps } from "@material-ui/core";
3
3
 
4
4
  export type HvActionContainerClassKey = "root";
5
5
 
6
- type HvActionContainerProps = StandardProps<React.HTMLAttributes<HTMLDivElement>, HvActionContainerClassKey>
6
+ export type HvActionContainerProps = StandardProps<
7
+ React.HTMLAttributes<HTMLDivElement>,
8
+ HvActionContainerClassKey
9
+ >;
7
10
 
8
11
  export default function HvActionContainer(props: HvActionContainerProps): JSX.Element | null;
@@ -4,36 +4,35 @@ import LinkTo from "@storybook/addon-links/react";
4
4
 
5
5
  import { Usage } from "storybook-root/blocks/Usage";
6
6
 
7
- import {
8
- SnackbarProvider,
9
- } from "./SnackbarProvider.stories.js";
7
+ import { SnackbarProvider } from "./SnackbarProvider.stories.js";
10
8
 
11
- <Meta title="Components/Snackbar/Provider" />
9
+ <Meta title="Feedback/Snackbar/Provider" />
12
10
 
13
11
  # Snackbar Provider
14
12
 
15
- The UI Kit library provides a snackbar provider
13
+ The UI Kit library provides a snackbar provider
16
14
  to control the stacking of multiple snackbars in the app.
17
15
 
18
- The providers is not meant to be 100% feature complete, but instead,
19
- ease the majority of use-cases we have been encountering.
20
- If you need any customization or extension to the behavior,
16
+ The providers is not meant to be 100% feature complete, but instead,
17
+ ease the majority of use-cases we have been encountering.
18
+ If you need any customization or extension to the behavior,
21
19
  please feel free to copy and customize it.
22
20
 
23
- This feature needs both the *HvSnackbarProvider* provider and the hook *useHvSnackbar*.
21
+ This feature needs both the _HvSnackbarProvider_ provider and the hook _useHvSnackbar_.
24
22
  The provider and the hook are wrappers of the [Notistack](https://github.com/iamhosseindhv/notistack) API.
25
23
 
26
24
  Ideally the `HvSnackbarProvider` should be at the top of the component tree of your application.
27
- This will allow the snackbar to be triggered in any page.
25
+ This will allow the snackbar to be triggered in any page.
28
26
  For more information of the provider API check the [notistack documentation](https://iamhosseindhv.com/notistack/api).
29
27
 
30
28
  <Usage>{'import { HvSnackbarProvider } from "@hitachivantara/uikit-react-core";'}</Usage>
31
29
 
32
- After adding the provider at the root of your app, you can call the ```useHvSnackbar``` at any
30
+ After adding the provider at the root of your app, you can call the `useHvSnackbar` at any
33
31
  component inside your app. This hook will allow you to request the rendering of a snackbar through the use
34
- of the ```enqueueSnackbar``` function which follows the API bellow:
32
+ of the `enqueueSnackbar` function which follows the API bellow:
35
33
 
36
34
  parameters:
35
+
37
36
  - `message: string | React.node`: The message to render inside the snackbar.
38
37
  - `options: HvEnqueueOptions`: The options to configure the snackbar.
39
38
  - `HvEnqueueOptions`:
@@ -42,6 +41,7 @@ parameters:
42
41
  - `snackbarContentProps?: HvSnackbarContentProps`: Extra properties to be passed onto the snackbar
43
42
 
44
43
  output:
44
+
45
45
  - `SnackbarKey: string | number`: How many snackbars to render.
46
46
 
47
47
  <Usage>{'import { useHvSnackbar } from "@hitachivantara/uikit-react-core";'}</Usage>
@@ -3,6 +3,9 @@ import { StandardProps } from "@material-ui/core";
3
3
 
4
4
  export type HvActionContainerClassKey = "root";
5
5
 
6
- type HvActionContainerProps = StandardProps<React.HTMLAttributes<HTMLDivElement>, HvActionContainerClassKey>
6
+ export type HvActionContainerProps = StandardProps<
7
+ React.HTMLAttributes<HTMLDivElement>,
8
+ HvActionContainerClassKey
9
+ >;
7
10
 
8
11
  export default function HvActionContainer(props: HvActionContainerProps): JSX.Element | null;
@@ -4,36 +4,35 @@ import LinkTo from "@storybook/addon-links/react";
4
4
 
5
5
  import { Usage } from "storybook-root/blocks/Usage";
6
6
 
7
- import {
8
- SnackbarProvider,
9
- } from "./SnackbarProvider.stories.js";
7
+ import { SnackbarProvider } from "./SnackbarProvider.stories.js";
10
8
 
11
- <Meta title="Components/Snackbar/Provider" />
9
+ <Meta title="Feedback/Snackbar/Provider" />
12
10
 
13
11
  # Snackbar Provider
14
12
 
15
- The UI Kit library provides a snackbar provider
13
+ The UI Kit library provides a snackbar provider
16
14
  to control the stacking of multiple snackbars in the app.
17
15
 
18
- The providers is not meant to be 100% feature complete, but instead,
19
- ease the majority of use-cases we have been encountering.
20
- If you need any customization or extension to the behavior,
16
+ The providers is not meant to be 100% feature complete, but instead,
17
+ ease the majority of use-cases we have been encountering.
18
+ If you need any customization or extension to the behavior,
21
19
  please feel free to copy and customize it.
22
20
 
23
- This feature needs both the *HvSnackbarProvider* provider and the hook *useHvSnackbar*.
21
+ This feature needs both the _HvSnackbarProvider_ provider and the hook _useHvSnackbar_.
24
22
  The provider and the hook are wrappers of the [Notistack](https://github.com/iamhosseindhv/notistack) API.
25
23
 
26
24
  Ideally the `HvSnackbarProvider` should be at the top of the component tree of your application.
27
- This will allow the snackbar to be triggered in any page.
25
+ This will allow the snackbar to be triggered in any page.
28
26
  For more information of the provider API check the [notistack documentation](https://iamhosseindhv.com/notistack/api).
29
27
 
30
28
  <Usage>{'import { HvSnackbarProvider } from "@hitachivantara/uikit-react-core";'}</Usage>
31
29
 
32
- After adding the provider at the root of your app, you can call the ```useHvSnackbar``` at any
30
+ After adding the provider at the root of your app, you can call the `useHvSnackbar` at any
33
31
  component inside your app. This hook will allow you to request the rendering of a snackbar through the use
34
- of the ```enqueueSnackbar``` function which follows the API bellow:
32
+ of the `enqueueSnackbar` function which follows the API bellow:
35
33
 
36
34
  parameters:
35
+
37
36
  - `message: string | React.node`: The message to render inside the snackbar.
38
37
  - `options: HvEnqueueOptions`: The options to configure the snackbar.
39
38
  - `HvEnqueueOptions`:
@@ -42,6 +41,7 @@ parameters:
42
41
  - `snackbarContentProps?: HvSnackbarContentProps`: Extra properties to be passed onto the snackbar
43
42
 
44
43
  output:
44
+
45
45
  - `SnackbarKey: string | number`: How many snackbars to render.
46
46
 
47
47
  <Usage>{'import { useHvSnackbar } from "@hitachivantara/uikit-react-core";'}</Usage>
@@ -3,6 +3,9 @@ import { StandardProps } from "@material-ui/core";
3
3
 
4
4
  export type HvActionContainerClassKey = "root";
5
5
 
6
- type HvActionContainerProps = StandardProps<React.HTMLAttributes<HTMLDivElement>, HvActionContainerClassKey>
6
+ export type HvActionContainerProps = StandardProps<
7
+ React.HTMLAttributes<HTMLDivElement>,
8
+ HvActionContainerClassKey
9
+ >;
7
10
 
8
11
  export default function HvActionContainer(props: HvActionContainerProps): JSX.Element | null;
@@ -4,36 +4,35 @@ import LinkTo from "@storybook/addon-links/react";
4
4
 
5
5
  import { Usage } from "storybook-root/blocks/Usage";
6
6
 
7
- import {
8
- SnackbarProvider,
9
- } from "./SnackbarProvider.stories.js";
7
+ import { SnackbarProvider } from "./SnackbarProvider.stories.js";
10
8
 
11
- <Meta title="Components/Snackbar/Provider" />
9
+ <Meta title="Feedback/Snackbar/Provider" />
12
10
 
13
11
  # Snackbar Provider
14
12
 
15
- The UI Kit library provides a snackbar provider
13
+ The UI Kit library provides a snackbar provider
16
14
  to control the stacking of multiple snackbars in the app.
17
15
 
18
- The providers is not meant to be 100% feature complete, but instead,
19
- ease the majority of use-cases we have been encountering.
20
- If you need any customization or extension to the behavior,
16
+ The providers is not meant to be 100% feature complete, but instead,
17
+ ease the majority of use-cases we have been encountering.
18
+ If you need any customization or extension to the behavior,
21
19
  please feel free to copy and customize it.
22
20
 
23
- This feature needs both the *HvSnackbarProvider* provider and the hook *useHvSnackbar*.
21
+ This feature needs both the _HvSnackbarProvider_ provider and the hook _useHvSnackbar_.
24
22
  The provider and the hook are wrappers of the [Notistack](https://github.com/iamhosseindhv/notistack) API.
25
23
 
26
24
  Ideally the `HvSnackbarProvider` should be at the top of the component tree of your application.
27
- This will allow the snackbar to be triggered in any page.
25
+ This will allow the snackbar to be triggered in any page.
28
26
  For more information of the provider API check the [notistack documentation](https://iamhosseindhv.com/notistack/api).
29
27
 
30
28
  <Usage>{'import { HvSnackbarProvider } from "@hitachivantara/uikit-react-core";'}</Usage>
31
29
 
32
- After adding the provider at the root of your app, you can call the ```useHvSnackbar``` at any
30
+ After adding the provider at the root of your app, you can call the `useHvSnackbar` at any
33
31
  component inside your app. This hook will allow you to request the rendering of a snackbar through the use
34
- of the ```enqueueSnackbar``` function which follows the API bellow:
32
+ of the `enqueueSnackbar` function which follows the API bellow:
35
33
 
36
34
  parameters:
35
+
37
36
  - `message: string | React.node`: The message to render inside the snackbar.
38
37
  - `options: HvEnqueueOptions`: The options to configure the snackbar.
39
38
  - `HvEnqueueOptions`:
@@ -42,6 +41,7 @@ parameters:
42
41
  - `snackbarContentProps?: HvSnackbarContentProps`: Extra properties to be passed onto the snackbar
43
42
 
44
43
  output:
44
+
45
45
  - `SnackbarKey: string | number`: How many snackbars to render.
46
46
 
47
47
  <Usage>{'import { useHvSnackbar } from "@hitachivantara/uikit-react-core";'}</Usage>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hitachivantara/uikit-react-core",
3
- "version": "3.67.13",
3
+ "version": "3.67.16",
4
4
  "description": "A collection of React components for the Hitachi Vantara's Design System.",
5
5
  "homepage": "https://github.com/lumada-design/hv-uikit-react",
6
6
  "license": "Apache-2.0",
@@ -105,5 +105,5 @@
105
105
  "publishConfig": {
106
106
  "access": "public"
107
107
  },
108
- "gitHead": "3b0e9071dfefe4a6f657e368fb21a073ea89b519"
108
+ "gitHead": "f74a9aa26307d43c822e2d0d2d22430050c4883b"
109
109
  }