@warp-ds/elements 1.0.0-alpha.6 → 1.0.0-alpha.8
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 +41 -24
- package/dist/{scripts.bd8d8c7c.js → index.js} +1007 -1180
- package/dist/packages/button/index.d.ts +1 -1
- package/package.json +2 -2
- package/dist/expandable.html +0 -428
- package/dist/index.html +0 -288
- package/dist/scripts.bd8d8c7c.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,39 +1,56 @@
|
|
|
1
|
-
# Warp Elements
|
|
1
|
+
# Warp-ds Elements
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Welcome to [@warp-ds/elements](https://github.com/warp-ds/elements),
|
|
4
|
+
a collection of Vue3 components for building user interfaces based on the [Warp Design System](https://github.com/warp-ds/).
|
|
5
|
+
This repository is maintained by the [Warp Core Team](https://github.com/orgs/warp-ds/teams/warp-core-team)
|
|
6
|
+
and is home to the [@warp-ds/vue](https://www.npmjs.com/package/@warp-ds/elements) library.
|
|
4
7
|
|
|
5
|
-
The project uses [Vite](https://vitejs.dev/) for "unbundled" local development. Start a local dev
|
|
6
|
-
server by running the following command:
|
|
7
8
|
|
|
9
|
+
## How to contribute
|
|
10
|
+
|
|
11
|
+
If you'd like to contribute to `@warp-ds/elements`,
|
|
12
|
+
start by reviewing the [contributing guidelines](CONTRIBUTING.md).
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## How to use
|
|
16
|
+
|
|
17
|
+
### Installation
|
|
18
|
+
|
|
19
|
+
Install by using npm/pnpm or by adding a script link:
|
|
20
|
+
|
|
21
|
+
#### Install using npm
|
|
22
|
+
```sh
|
|
23
|
+
npm i -S @warp-ds/elements
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
#### Install using pnpm
|
|
8
27
|
```sh
|
|
9
|
-
pnpm
|
|
28
|
+
pnpm add @warp-ds/elements
|
|
10
29
|
```
|
|
11
30
|
|
|
12
|
-
|
|
31
|
+
#### Using a direct link to Eik
|
|
32
|
+
```html
|
|
33
|
+
<script src="https://assets.finn.no/pkg/@warp-ds/elements/v1"></script>
|
|
34
|
+
```
|
|
13
35
|
|
|
36
|
+
### Documentation
|
|
14
37
|
|
|
15
|
-
|
|
38
|
+
For information on the components available in the package and how to use them,
|
|
39
|
+
see the [Warp Design System documentation](https://warp-ds.github.io/tech-docs/).
|
|
16
40
|
|
|
17
|
-
This project uses
|
|
18
|
-
[Semantic Release](https://github.com/semantic-release/semantic-release) to
|
|
19
|
-
automate package publishing when making changes to the `main` or `alpha` branch.
|
|
20
41
|
|
|
21
|
-
|
|
22
|
-
updated with the latest `main`.
|
|
23
|
-
Follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)
|
|
24
|
-
when making changes. When your changes are ready for pull request, this should be
|
|
25
|
-
opened against the `alpha` branch.
|
|
42
|
+
## Releases
|
|
26
43
|
|
|
44
|
+
This project is currently in alpha.
|
|
45
|
+
Continuously published to [NPM](https://www.npmjs.com/package/@warp-ds/elements) and [Eik](https://assets.finn.no/pkg/@warp-ds/elements) using an `alpha` tag (e.g. `1.0.0-alpha.1`).
|
|
46
|
+
Anyone needing to start using the package before the first major release can install the `alpha` version while waiting for the first stable version.
|
|
27
47
|
|
|
28
|
-
Please note that the version published will depend on your commit message
|
|
29
|
-
structure. You can use [commitizen](https://github.com/commitizen/cz-cli) to help
|
|
30
|
-
follow this structure:
|
|
31
48
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
49
|
+
## Changelog
|
|
50
|
+
|
|
51
|
+
Detailed changes for each release can be found in the [CHANGELOG](CHANGELOG.md) file.
|
|
52
|
+
|
|
35
53
|
|
|
36
|
-
|
|
37
|
-
commit your changes (replacing `git commit`).
|
|
54
|
+
## License
|
|
38
55
|
|
|
39
|
-
|
|
56
|
+
@warp-ds/elements is available under the [Apache-2.0 software license](https://github.com/warp-ds/elements/blob/main/LICENSE).
|