@gridui/inline-notice 1.0.6 → 1.0.8
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 +4 -2
- package/dist/styles.css +3 -3
- package/docs/catalog.json +8 -5
- package/docs/reference/README.md +4 -0
- package/docs/reference/inline-notice.md +81 -0
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -9,8 +9,10 @@ See [component ownership](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/
|
|
|
9
9
|
|
|
10
10
|
## Inline feedback
|
|
11
11
|
|
|
12
|
-
Import `InlineNotice` and its props from
|
|
12
|
+
Import `InlineNotice` and its props from `@gridui/inline-notice`; see the
|
|
13
13
|
[announcement and actions contract](docs/inline-notice.md). Tone and announcement
|
|
14
14
|
policy remain independent. Applications can supply an action component without
|
|
15
|
-
making
|
|
15
|
+
making InlineNotice depend on that component's package.
|
|
16
16
|
|
|
17
|
+
|
|
18
|
+
[Component reference](docs/reference/README.md) contains focused API pages for each public component.
|
package/dist/styles.css
CHANGED
|
@@ -14,13 +14,13 @@
|
|
|
14
14
|
color: var(--gridui-foreground);
|
|
15
15
|
}
|
|
16
16
|
.gridui-inline-notice[data-tone="success"] {
|
|
17
|
-
border-inline-start: 4px solid var(--gridui-
|
|
17
|
+
border-inline-start: 4px solid var(--gridui-status-success-border);
|
|
18
18
|
}
|
|
19
19
|
.gridui-inline-notice[data-tone="warning"] {
|
|
20
|
-
border-inline-start: 4px solid var(--gridui-warning-
|
|
20
|
+
border-inline-start: 4px solid var(--gridui-status-warning-border);
|
|
21
21
|
}
|
|
22
22
|
.gridui-inline-notice[data-tone="danger"] {
|
|
23
|
-
border-inline-start: 4px solid var(--gridui-danger-
|
|
23
|
+
border-inline-start: 4px solid var(--gridui-status-danger-border);
|
|
24
24
|
}
|
|
25
25
|
.gridui-inline-notice-icon {
|
|
26
26
|
display: inline-flex;
|
package/docs/catalog.json
CHANGED
|
@@ -1,13 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": 1,
|
|
3
3
|
"name": "@gridui/inline-notice",
|
|
4
|
-
"version": "1.0.
|
|
4
|
+
"version": "1.0.8",
|
|
5
5
|
"category": "core",
|
|
6
6
|
"description": "GridUI React inline notice",
|
|
7
|
-
"usage": "
|
|
7
|
+
"usage": "Component reference contains focused API pages for each public component.",
|
|
8
8
|
"documentation": [
|
|
9
9
|
"README.md",
|
|
10
|
-
"docs/inline-notice.md"
|
|
10
|
+
"docs/inline-notice.md",
|
|
11
|
+
"docs/reference/README.md",
|
|
12
|
+
"docs/reference/inline-notice.md"
|
|
11
13
|
],
|
|
12
14
|
"exports": [
|
|
13
15
|
{
|
|
@@ -26,7 +28,8 @@
|
|
|
26
28
|
"@gridui/inline-notice/styles.css"
|
|
27
29
|
],
|
|
28
30
|
"examples": [
|
|
29
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/
|
|
30
|
-
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/
|
|
31
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/content-feedback.mdx",
|
|
32
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/getting-started.mdx",
|
|
33
|
+
"https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/inline-notice.stories.tsx"
|
|
31
34
|
]
|
|
32
35
|
}
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
<!-- Generated from public Props and owned stories. Run pnpm docs:storybook. -->
|
|
2
|
+
# InlineNotice
|
|
3
|
+
|
|
4
|
+
Shows contextual information, warnings, or errors beside relevant content. Use it when feedback should remain in the page rather than appear as a toast.
|
|
5
|
+
|
|
6
|
+
Import from ``@gridui/inline-notice`` and load Theme before this family's stylesheet.
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { InlineNotice } from "@gridui/inline-notice";
|
|
10
|
+
import "@gridui/theme/styles.css";
|
|
11
|
+
import "@gridui/inline-notice/styles.css";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Read the [package contract](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/README.md) for shared behavior and stylesheet dependencies.
|
|
15
|
+
|
|
16
|
+
The [working composition](https://github.com/sudo-ui/GridUI-React-Monorepo/blob/main/packages-core/inline-notice/stories/inline-notice.stories.tsx) demonstrates required context, state, and related components. Use View code in Storybook to inspect the actual implementation.
|
|
17
|
+
|
|
18
|
+
## API
|
|
19
|
+
|
|
20
|
+
The public Props type is the source of these signatures. Defaults below are explicit implementation defaults; story presets are separate. Native attributes remain available through the exported Props type.
|
|
21
|
+
|
|
22
|
+
### children
|
|
23
|
+
|
|
24
|
+
``ReactNode`` · Optional
|
|
25
|
+
|
|
26
|
+
Content rendered inside the component.
|
|
27
|
+
|
|
28
|
+
### onFocus
|
|
29
|
+
|
|
30
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
31
|
+
|
|
32
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
33
|
+
|
|
34
|
+
### onBlur
|
|
35
|
+
|
|
36
|
+
``(event: FocusEvent<HTMLDivElement, Element>): void`` · Optional
|
|
37
|
+
|
|
38
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
39
|
+
|
|
40
|
+
### onChange
|
|
41
|
+
|
|
42
|
+
``(event: ChangeEvent<HTMLDivElement, Element>): void`` · Optional
|
|
43
|
+
|
|
44
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
45
|
+
|
|
46
|
+
### onSubmit
|
|
47
|
+
|
|
48
|
+
``(event: SubmitEvent<HTMLDivElement>): void`` · Optional
|
|
49
|
+
|
|
50
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
51
|
+
|
|
52
|
+
### onClick
|
|
53
|
+
|
|
54
|
+
``(event: MouseEvent<HTMLDivElement, MouseEvent>): void`` · Optional
|
|
55
|
+
|
|
56
|
+
Called when the corresponding interaction occurs; inspect the arguments in Actions.
|
|
57
|
+
|
|
58
|
+
### title
|
|
59
|
+
|
|
60
|
+
``ReactNode`` · Optional
|
|
61
|
+
|
|
62
|
+
### icon
|
|
63
|
+
|
|
64
|
+
``ReactNode`` · Optional
|
|
65
|
+
|
|
66
|
+
### actions
|
|
67
|
+
|
|
68
|
+
``ReactNode`` · Optional
|
|
69
|
+
|
|
70
|
+
### tone
|
|
71
|
+
|
|
72
|
+
``"neutral" | "success" | "warning" | "danger" | undefined`` · Optional
|
|
73
|
+
|
|
74
|
+
Default: ``"neutral"``
|
|
75
|
+
|
|
76
|
+
### announcement
|
|
77
|
+
|
|
78
|
+
``"off" | "polite" | "assertive" | undefined`` · Optional
|
|
79
|
+
|
|
80
|
+
Default: ``"off"``
|
|
81
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gridui/inline-notice",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.8",
|
|
4
4
|
"description": "GridUI React inline notice",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"type": "module",
|
|
@@ -27,13 +27,14 @@
|
|
|
27
27
|
"react-dom": "^19.2.0"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@gridui/style-utils": "^
|
|
31
|
-
"@gridui/theme": "^
|
|
30
|
+
"@gridui/style-utils": "^4.0.0",
|
|
31
|
+
"@gridui/theme": "^3.0.0"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@gridui-internal/configuration": "0.0.0-internal",
|
|
35
|
+
"@gridui/button": "5.1.0",
|
|
35
36
|
"@jest/globals": "30.5.2",
|
|
36
|
-
"@storybook/react-vite": "10.6.
|
|
37
|
+
"@storybook/react-vite": "10.6.7",
|
|
37
38
|
"@types/jest": "30.0.0",
|
|
38
39
|
"@types/node": "26.6.6",
|
|
39
40
|
"@types/react": "19.3.0",
|
|
@@ -46,7 +47,6 @@
|
|
|
46
47
|
"scripts": {
|
|
47
48
|
"build": "node ../../scripts/compilation/package.ts",
|
|
48
49
|
"compile": "tsc --project tsconfig.json",
|
|
49
|
-
"test": "jest"
|
|
50
|
-
"coverage": "jest --coverage"
|
|
50
|
+
"test": "jest"
|
|
51
51
|
}
|
|
52
52
|
}
|