@vellira-ui/types 2.54.0 → 2.56.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 +26 -5
- package/package.json +14 -1
package/README.md
CHANGED
|
@@ -1,14 +1,26 @@
|
|
|
1
1
|
# @vellira-ui/types
|
|
2
2
|
|
|
3
|
-
Platform-agnostic
|
|
3
|
+
Platform-agnostic component contracts for Vellira.
|
|
4
4
|
|
|
5
|
-
This package
|
|
5
|
+
This package defines shared value, state, sizing, positioning, and component
|
|
6
|
+
contracts used by the React and React Native implementations.
|
|
7
|
+
|
|
8
|
+
It intentionally avoids React, DOM, CSS, and React Native-specific props.
|
|
9
|
+
Renderer packages extend these contracts with platform-specific fields such as
|
|
10
|
+
`children`, `className`, `style`, accessibility properties, and event handlers.
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
pnpm add @vellira-ui/types
|
|
16
|
+
```
|
|
6
17
|
|
|
7
18
|
## Purpose
|
|
8
19
|
|
|
9
|
-
- Share stable
|
|
10
|
-
- Keep
|
|
11
|
-
-
|
|
20
|
+
- Share stable contracts between web and native
|
|
21
|
+
- Keep component APIs aligned across renderers
|
|
22
|
+
- Centralize shared value and state types
|
|
23
|
+
- Avoid coupling shared definitions to React or a rendering platform
|
|
12
24
|
|
|
13
25
|
## Usage
|
|
14
26
|
|
|
@@ -20,8 +32,17 @@ export interface CheckboxProps extends BaseCheckboxProps {
|
|
|
20
32
|
}
|
|
21
33
|
```
|
|
22
34
|
|
|
35
|
+
Shared contracts cover component APIs including Button, Checkbox, FormField,
|
|
36
|
+
Modal, Popover, Radio, Select, Tabs, and Tooltip.
|
|
37
|
+
|
|
38
|
+
## Documentation
|
|
39
|
+
|
|
40
|
+
- [React](https://docs.vellira.dev/react/)
|
|
41
|
+
- [React Native](https://docs.vellira.dev/react-native/)
|
|
42
|
+
|
|
23
43
|
## Development
|
|
24
44
|
|
|
25
45
|
```bash
|
|
26
46
|
pnpm --filter @vellira-ui/types build
|
|
47
|
+
pnpm --filter @vellira-ui/types typecheck
|
|
27
48
|
```
|
package/package.json
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vellira-ui/types",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.56.0",
|
|
4
4
|
"description": "Shared TypeScript types for Vellira Design System",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"vellira",
|
|
7
|
+
"typescript",
|
|
8
|
+
"types",
|
|
9
|
+
"design-system",
|
|
10
|
+
"react",
|
|
11
|
+
"react-native",
|
|
12
|
+
"ui"
|
|
13
|
+
],
|
|
5
14
|
"author": "Roman Bakurov",
|
|
6
15
|
"license": "MIT",
|
|
7
16
|
"repository": {
|
|
@@ -9,6 +18,10 @@
|
|
|
9
18
|
"url": "git+https://github.com/vellira-dev/vellira.git",
|
|
10
19
|
"directory": "packages/types"
|
|
11
20
|
},
|
|
21
|
+
"homepage": "https://vellira.dev",
|
|
22
|
+
"bugs": {
|
|
23
|
+
"url": "https://github.com/vellira-dev/vellira/issues"
|
|
24
|
+
},
|
|
12
25
|
"private": false,
|
|
13
26
|
"type": "module",
|
|
14
27
|
"sideEffects": false,
|