@ship-ui/core 0.13.4 → 0.13.6
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 +93 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,94 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ⛵ Ship UI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A modern signal based and zoneless compatable UI library for Angular
|
|
4
|
+
|
|
5
|
+
## Base setup
|
|
6
|
+
|
|
7
|
+
To start using ShipUI make sure you're using angular 19 or newer.
|
|
8
|
+
|
|
9
|
+
### Install
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm i -S @ship/core
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Add styles inside your src/styles.scss
|
|
16
|
+
|
|
17
|
+
```scss
|
|
18
|
+
@use 'ship-ui/styles';
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
### Inside your angular.json file
|
|
22
|
+
|
|
23
|
+
you need to add the ship assets to your assets array this is to add the ship default font
|
|
24
|
+
|
|
25
|
+
```json
|
|
26
|
+
"assets": [
|
|
27
|
+
"src/assets",
|
|
28
|
+
{
|
|
29
|
+
"glob": "**/*",
|
|
30
|
+
"input": "./node_modules/ship-ui/assets",
|
|
31
|
+
"output": "./ship-ui-assets/"
|
|
32
|
+
}
|
|
33
|
+
]
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Setup Icons
|
|
37
|
+
|
|
38
|
+
Ship comes with a custom CLI for subsetting and auto generating an icon font currently we support Phospher icons
|
|
39
|
+
|
|
40
|
+
```html
|
|
41
|
+
<!-- Add to the head of your index.html -->
|
|
42
|
+
<link rel="stylesheet" href="/ship.css" />
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Add following scripts to your package.json scripts
|
|
46
|
+
|
|
47
|
+
One are for generating the icon font once, the other has a watch feature.
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
"scripts": {
|
|
51
|
+
..
|
|
52
|
+
"gen:font": "ship-fg --src='./src' --out='./src/assets' --rootPath='./'",
|
|
53
|
+
"watch:font": "ship-fg --src='./src' --out='./src/assets' --rootPath='./' --watch",
|
|
54
|
+
..
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Now update your current start and build scripts
|
|
59
|
+
|
|
60
|
+
You now wanna add when to build the font and when to watch so it works well together with your start and build, **remember** to add the `npm run gen:font` to all your build scripts
|
|
61
|
+
|
|
62
|
+
```json
|
|
63
|
+
"scripts": {
|
|
64
|
+
..
|
|
65
|
+
"start": "npm run watch:font & ng serve",
|
|
66
|
+
"build": "npm run gen:font & ng build",
|
|
67
|
+
..
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Follow our progress
|
|
72
|
+
|
|
73
|
+
We have a [todos](documents/todos.md) file where we try keep track of features/bugs/blockers currently in pipeline etc
|
|
74
|
+
|
|
75
|
+
## Notes
|
|
76
|
+
|
|
77
|
+
- <strike>There was raised thoughts on separating out the icon utility the decision are for now not to since this package are depended on those icons for now, we can open up a new debate about it if some comes with a solid argument for it</strike>
|
|
78
|
+
- <strike>For safari `<18` the selects does not support using options so you must use `<sh-option>` instead of `<option>` (this is fixed in the next select version currently suffixed with `-new`)</strike> (We circumvent this by using a templates instead of options)
|
|
79
|
+
- Known issues for selects when having two selects editing the same value and it is a multi select and searchable they clear out when opened also when selecting a new item they clear the rest of the list - not a very likely scenario but it is something to keep in mind (Your UI probably should not allow this scenario write an issue if you think it should be possible with a good explanation and example)
|
|
80
|
+
|
|
81
|
+
## Contributors
|
|
82
|
+
|
|
83
|
+
### Creators
|
|
84
|
+
|
|
85
|
+
- [Simon - development](https://github.com/sp90)
|
|
86
|
+
- [Morten - design](https://x.com/mortenpx)
|
|
87
|
+
|
|
88
|
+
### Sponsors
|
|
89
|
+
|
|
90
|
+
- [Duplicati](https://duplicati.com)
|
|
91
|
+
|
|
92
|
+
## License
|
|
93
|
+
|
|
94
|
+
MIT
|