@xsolla/xui-status 0.95.0 → 0.97.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 +34 -0
- package/package.json +3 -3
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# @xsolla/xui-status
|
|
2
|
+
|
|
3
|
+
An accessible status indicator with a coloured dot and optional label for representing availability or system states.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
yarn add @xsolla/xui-status
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Status } from "@xsolla/xui-status";
|
|
15
|
+
|
|
16
|
+
<Status palette="success">Online</Status>
|
|
17
|
+
<Status palette="warning">Away</Status>
|
|
18
|
+
<Status palette="alert">Error</Status>
|
|
19
|
+
|
|
20
|
+
{/* Dot-only */}
|
|
21
|
+
<Status palette="neutral" />
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Props
|
|
25
|
+
|
|
26
|
+
### Status
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Default | Description |
|
|
29
|
+
|------|------|---------|-------------|
|
|
30
|
+
| `palette` | `"default" \| "success" \| "warning" \| "alert" \| "neutral"` | `"default"` | Dot colour |
|
|
31
|
+
| `size` | `"sm" \| "md" \| "lg"` | `"md"` | Size of the dot and label text |
|
|
32
|
+
| `labelType` | `"primary" \| "dot-color"` | `"primary"` | Label colour; `"dot-color"` matches the dot colour |
|
|
33
|
+
| `aria-label` | `string` | — | Explicit accessible label; auto-generated for string children |
|
|
34
|
+
| `aria-live` | `"polite" \| "assertive" \| "off"` | — | Live region behaviour for dynamic updates |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xsolla/xui-status",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.97.0",
|
|
4
4
|
"main": "./web/index.js",
|
|
5
5
|
"module": "./web/index.mjs",
|
|
6
6
|
"types": "./web/index.d.ts",
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
"build:native": "PLATFORM=native tsup"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@xsolla/xui-core": "0.
|
|
14
|
-
"@xsolla/xui-primitives-core": "0.
|
|
13
|
+
"@xsolla/xui-core": "0.97.0",
|
|
14
|
+
"@xsolla/xui-primitives-core": "0.97.0"
|
|
15
15
|
},
|
|
16
16
|
"peerDependencies": {
|
|
17
17
|
"react": ">=16.8.0",
|