@wire-dsl/engine 0.0.2 → 0.1.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/LICENSE +0 -15
- package/README.md +32 -18
- package/dist/index.cjs +1138 -36
- package/dist/index.d.cts +475 -1
- package/dist/index.d.ts +475 -1
- package/dist/index.js +1132 -36
- package/package.json +1 -1
package/LICENSE
CHANGED
|
@@ -19,18 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
19
19
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
20
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
21
|
SOFTWARE.
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## Third-Party Components & Assets
|
|
26
|
-
|
|
27
|
-
### Feather Icons
|
|
28
|
-
|
|
29
|
-
This project includes icons from Feather Icons (https://feathericons.com), created by Cole Bemis and contributors.
|
|
30
|
-
|
|
31
|
-
- **License**: MIT License
|
|
32
|
-
- **Repository**: https://github.com/feathericons/feather
|
|
33
|
-
- **Location in project**: `packages/core/src/renderer/icons/`
|
|
34
|
-
- **Full details**: See `packages/core/src/renderer/icons/ICONS-LICENSE.md`
|
|
35
|
-
|
|
36
|
-
Feather Icons are used under the terms of the MIT License, which is fully compatible with this project's MIT License.
|
package/README.md
CHANGED
|
@@ -11,13 +11,24 @@ npm install @wire-dsl/engine
|
|
|
11
11
|
## Quick Start
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import { parseWire, generateIR, computeLayout
|
|
14
|
+
import { parseWire, generateIR, computeLayout } from '@wire-dsl/engine';
|
|
15
15
|
|
|
16
16
|
// Parse .wire DSL file
|
|
17
17
|
const ast = parseWire(`
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
18
|
+
project "MyWireframe" {
|
|
19
|
+
theme {
|
|
20
|
+
density: "normal"
|
|
21
|
+
spacing: "md"
|
|
22
|
+
radius: "md"
|
|
23
|
+
stroke: "normal"
|
|
24
|
+
font: "base"
|
|
25
|
+
}
|
|
26
|
+
screen Home {
|
|
27
|
+
layout stack(direction: vertical, gap: md, padding: lg) {
|
|
28
|
+
component Heading text: "Welcome"
|
|
29
|
+
component Button text: "Click me" variant: primary
|
|
30
|
+
}
|
|
31
|
+
}
|
|
21
32
|
}
|
|
22
33
|
`);
|
|
23
34
|
|
|
@@ -65,22 +76,25 @@ validateIR(ir); // Throws if invalid
|
|
|
65
76
|
```
|
|
66
77
|
|
|
67
78
|
### Components
|
|
68
|
-
|
|
79
|
+
30+ built-in UI components:
|
|
69
80
|
|
|
70
|
-
**
|
|
71
|
-
- Text, Heading, Button, Link
|
|
81
|
+
**Text**: Heading, Text, Paragraph, Label
|
|
72
82
|
|
|
73
|
-
**
|
|
74
|
-
- Input, TextArea, Select, Checkbox, Radio
|
|
83
|
+
**Input**: Input, Textarea, Select, Checkbox, Radio, Toggle
|
|
75
84
|
|
|
76
|
-
**
|
|
77
|
-
- Stack, Grid, Split, Panel, Card
|
|
85
|
+
**Buttons**: Button, IconButton
|
|
78
86
|
|
|
79
|
-
**
|
|
80
|
-
- Modal, Dialog, Tabs, Accordion
|
|
87
|
+
**Navigation**: Topbar, SidebarMenu, Breadcrumbs, Tabs
|
|
81
88
|
|
|
82
|
-
**
|
|
83
|
-
|
|
89
|
+
**Data**: Table, List
|
|
90
|
+
|
|
91
|
+
**Media**: Image, Icon, Avatar
|
|
92
|
+
|
|
93
|
+
**Display**: Divider, Badge, Link, Alert
|
|
94
|
+
|
|
95
|
+
**Info**: StatCard, Code, ChartPlaceholder
|
|
96
|
+
|
|
97
|
+
**Feedback**: Modal, Spinner
|
|
84
98
|
|
|
85
99
|
## Features
|
|
86
100
|
|
|
@@ -93,9 +107,9 @@ validateIR(ir); // Throws if invalid
|
|
|
93
107
|
|
|
94
108
|
## Documentation
|
|
95
109
|
|
|
96
|
-
- [IR Contract Specification](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/IR-CONTRACT
|
|
97
|
-
- [Layout Engine Algorithm](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/LAYOUT-ENGINE
|
|
98
|
-
- [Validation Rules](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/VALIDATION-RULES
|
|
110
|
+
- [IR Contract Specification](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/IR-CONTRACT.md)
|
|
111
|
+
- [Layout Engine Algorithm](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/LAYOUT-ENGINE.md)
|
|
112
|
+
- [Validation Rules](https://github.com/Wire-DSL/wire-dsl/blob/main/specs/VALIDATION-RULES.md)
|
|
99
113
|
|
|
100
114
|
## License
|
|
101
115
|
|