@synerise/ds-alert 1.1.61 → 1.1.62
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/CHANGELOG.md +4 -0
- package/CLAUDE.md +101 -0
- package/package.json +10 -9
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.1.62](https://github.com/Synerise/synerise-design/compare/@synerise/ds-alert@1.1.61...@synerise/ds-alert@1.1.62) (2026-07-23)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @synerise/ds-alert
|
|
9
|
+
|
|
6
10
|
## [1.1.61](https://github.com/Synerise/synerise-design/compare/@synerise/ds-alert@1.1.60...@synerise/ds-alert@1.1.61) (2026-07-16)
|
|
7
11
|
|
|
8
12
|
**Note:** Version bump only for package @synerise/ds-alert
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Alert (`@synerise/ds-alert`)
|
|
2
|
+
|
|
3
|
+
> **DEPRECATED PACKAGE.** Do not add new usages. Four purpose-built replacement packages exist; see migration table below.
|
|
4
|
+
|
|
5
|
+
## Migration
|
|
6
|
+
|
|
7
|
+
| Export from `@synerise/ds-alert` | Replacement |
|
|
8
|
+
|----------------------------------|-------------|
|
|
9
|
+
| `Toast` | `@synerise/ds-toast` |
|
|
10
|
+
| `BroadcastBar` | `@synerise/ds-broadcast-bar` |
|
|
11
|
+
| `InlineAlert` / `IconAlert` | `@synerise/ds-inline-alert` |
|
|
12
|
+
| `SectionMessage` | `@synerise/ds-section-message` |
|
|
13
|
+
| `AlertInfo` | `@synerise/ds-result` (discouraged — no direct replacement yet) |
|
|
14
|
+
| `Alert` (default) | `@synerise/ds-section-message` or `@synerise/ds-toast` depending on use case |
|
|
15
|
+
| `AlertSemanticColor` | No direct replacement — use discouraged |
|
|
16
|
+
|
|
17
|
+
## Package structure
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
src/
|
|
21
|
+
Alert.tsx — main Alert component (Ant Design wrapper, deprecated)
|
|
22
|
+
Alert.types.ts — AlertType, Props (extends antd AlertProps)
|
|
23
|
+
Alert.styles.tsx — AntdAlert, AlertContent, AlertMessage, AlertDescription
|
|
24
|
+
index.ts — all exports
|
|
25
|
+
InlineAlert/ — thin wrapper → @synerise/ds-inline-alert
|
|
26
|
+
IconAlert/ — re-export → @synerise/ds-inline-alert (deprecated)
|
|
27
|
+
SectionMessage/ — re-export → @synerise/ds-section-message (deprecated)
|
|
28
|
+
BroadcastBar/ — re-export → @synerise/ds-broadcast-bar (deprecated)
|
|
29
|
+
Toast/ — standalone toast (deprecated, use @synerise/ds-toast)
|
|
30
|
+
AlertInfo/ — full-page status illustration component (discouraged)
|
|
31
|
+
ColorSemantic/ — semantic color icon box (no replacement, discouraged)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Public exports
|
|
35
|
+
|
|
36
|
+
### `Alert` (default) — **deprecated**
|
|
37
|
+
|
|
38
|
+
Wraps Ant Design `Alert`. Extends `antd/AlertProps` with:
|
|
39
|
+
|
|
40
|
+
| Prop | Type | Default | Description |
|
|
41
|
+
|------|------|---------|-------------|
|
|
42
|
+
| `type` | `'success' \| 'warning' \| 'error' \| 'info'` | — | **Required.** Semantic type |
|
|
43
|
+
| `message` | `ReactNode` | `undefined` | Alert message content |
|
|
44
|
+
| `color` | `'blue' \| 'grey' \| 'red' \| 'green' \| 'yellow' \| 'pink' \| 'mars' \| 'orange' \| 'fern' \| 'cyan' \| 'purple' \| 'violet'` | `undefined` | Colour override |
|
|
45
|
+
| `mode` | `'background' \| 'background-outline' \| 'outline' \| 'clear'` | `undefined` | Visual style mode |
|
|
46
|
+
| `showMoreLabel` | `ReactNode` | `undefined` | Label for "show more" link |
|
|
47
|
+
| `onShowMore` | `() => void` | `undefined` | "Show more" click handler |
|
|
48
|
+
|
|
49
|
+
Has `Alert.InlineAlert` sub-component (forwards to `InlineAlert`).
|
|
50
|
+
|
|
51
|
+
### `Toast` — **deprecated**, use `@synerise/ds-toast`
|
|
52
|
+
|
|
53
|
+
Standalone toast notification. Extends `antd/AlertProps` with extensive colour and expand props. See source `Toast.types.ts` for full prop list.
|
|
54
|
+
|
|
55
|
+
### `InlineAlert` — **deprecated**, use `@synerise/ds-inline-alert`
|
|
56
|
+
|
|
57
|
+
Thin wrapper around `@synerise/ds-inline-alert`. Props: `type: 'success' | 'alert' | 'warning' | 'info'`, `message: ReactNode`.
|
|
58
|
+
|
|
59
|
+
### `SectionMessage` — **deprecated**, use `@synerise/ds-section-message`
|
|
60
|
+
|
|
61
|
+
Direct re-export from `@synerise/ds-section-message`.
|
|
62
|
+
|
|
63
|
+
### `BroadcastBar` — **deprecated**, use `@synerise/ds-broadcast-bar`
|
|
64
|
+
|
|
65
|
+
Direct re-export from `@synerise/ds-broadcast-bar`.
|
|
66
|
+
|
|
67
|
+
### `IconAlert` — **deprecated**, use `@synerise/ds-inline-alert`
|
|
68
|
+
|
|
69
|
+
Alias for `InlineAlert`. Re-exports from `@synerise/ds-inline-alert`.
|
|
70
|
+
|
|
71
|
+
### `AlertInfo` — **discouraged**, no direct replacement
|
|
72
|
+
|
|
73
|
+
Full-page status illustration (icon + text + optional button). Props: `type`, `size` (`AlertSize.SMALL`=48px | `AlertSize.MEDIUM`=96px), `label`, `labelPosition`, `text`, `button`, `fontSize`, `mode`.
|
|
74
|
+
|
|
75
|
+
### `AlertSemanticColor` — **discouraged**, no direct replacement
|
|
76
|
+
|
|
77
|
+
100×100 px coloured icon box with 8 semantic types and 4 visual modes. Not exported from `index.ts` — only accessible via deep import.
|
|
78
|
+
|
|
79
|
+
### `AlertStyles`
|
|
80
|
+
|
|
81
|
+
```ts
|
|
82
|
+
{ Alert: typeof MainAlertStyles, Toast: typeof ToastStyles }
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Exported for consumers that need to extend styles. `AlertMessage` from `Alert.styles` is also exported directly (deprecated — use `AlertStyles.Alert` instead).
|
|
86
|
+
|
|
87
|
+
### `AlertSize`
|
|
88
|
+
|
|
89
|
+
```ts
|
|
90
|
+
enum AlertSize { SMALL = 48, MEDIUM = 96 }
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Used by `AlertInfo`.
|
|
94
|
+
|
|
95
|
+
## Implementation notes
|
|
96
|
+
|
|
97
|
+
- `SectionMessage`, `BroadcastBar`, and `IconAlert` are **one-line re-exports** — they add no logic, just re-export from their respective packages.
|
|
98
|
+
- `InlineAlert` has its own thin styled wrapper (`InlineAlert.styles.ts`) on top of `@synerise/ds-inline-alert` — the styles may diverge from the source package.
|
|
99
|
+
- `Toast` is a **full standalone implementation** (not a re-export). It uses `animate.css` keyframe animations and Ant Design `Alert` as its base. It is **not** a re-export of `@synerise/ds-toast`.
|
|
100
|
+
- `Alert` default icons are `Check2M` (success), `Close2M` (error), `NotificationsM` (warning/info) from `@synerise/ds-icon`.
|
|
101
|
+
- Ant Design 4.x (`antd ^4.24.16`) is a peer dependency — this package is tied to antd 4.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@synerise/ds-alert",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.62",
|
|
4
4
|
"description": "Alert UI Component for the Synerise Design System",
|
|
5
5
|
"license": "ISC",
|
|
6
6
|
"repository": "Synerise/synerise-design",
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
"files": [
|
|
18
18
|
"/dist",
|
|
19
19
|
"CHANGELOG.md",
|
|
20
|
+
"CLAUDE.md",
|
|
20
21
|
"README.md",
|
|
21
22
|
"package.json",
|
|
22
23
|
"LICENSE.md"
|
|
@@ -41,13 +42,13 @@
|
|
|
41
42
|
],
|
|
42
43
|
"types": "dist/index.d.ts",
|
|
43
44
|
"dependencies": {
|
|
44
|
-
"@synerise/ds-broadcast-bar": "^1.1.
|
|
45
|
-
"@synerise/ds-button": "^1.5.
|
|
46
|
-
"@synerise/ds-icon": "^1.18.
|
|
47
|
-
"@synerise/ds-inline-alert": "^1.1.
|
|
48
|
-
"@synerise/ds-section-message": "^1.0.
|
|
49
|
-
"@synerise/ds-unordered-list": "^1.1.
|
|
50
|
-
"@synerise/ds-utils": "^1.10.
|
|
45
|
+
"@synerise/ds-broadcast-bar": "^1.1.29",
|
|
46
|
+
"@synerise/ds-button": "^1.5.35",
|
|
47
|
+
"@synerise/ds-icon": "^1.18.5",
|
|
48
|
+
"@synerise/ds-inline-alert": "^1.1.28",
|
|
49
|
+
"@synerise/ds-section-message": "^1.0.39",
|
|
50
|
+
"@synerise/ds-unordered-list": "^1.1.54",
|
|
51
|
+
"@synerise/ds-utils": "^1.10.2",
|
|
51
52
|
"animate.css": "^4.1.1"
|
|
52
53
|
},
|
|
53
54
|
"peerDependencies": {
|
|
@@ -57,5 +58,5 @@
|
|
|
57
58
|
"styled-components": "^5.3.3",
|
|
58
59
|
"vitest": "4"
|
|
59
60
|
},
|
|
60
|
-
"gitHead": "
|
|
61
|
+
"gitHead": "d0a43cc43d8528a36f105aceea52ab470edb71d9"
|
|
61
62
|
}
|