scu-web-components 0.0.7 → 0.0.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 +23 -19
- package/dist/custom-elements.json +4255 -4255
- package/dist/docs/components/manifest.json +77 -77
- package/dist/docs/config.json +1 -1
- package/dist/docs/documents/Release History.html +5 -0
- package/dist/tokens/source/jsCss.js +1 -1
- package/dist/tokens/source/jsCss.js.gz +0 -0
- package/dist/tokens/source/jsCssGenerator.js +1 -1
- package/dist/tokens/source/jsCssGenerator.js.gz +0 -0
- package/dist/tokens/source/jsCssGeneratorSansAssets.js +1 -1
- package/dist/tokens/source/jsCssGeneratorSansAssets.js.gz +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Summit Credit Union Website Components
|
|
2
2
|
|
|
3
3
|
This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
|
|
4
4
|
|
|
@@ -8,23 +8,19 @@ npm i scu-web-components
|
|
|
8
8
|
```
|
|
9
9
|
|
|
10
10
|
## Usage
|
|
11
|
-
|
|
12
11
|
```html
|
|
13
12
|
<script type="module">
|
|
14
13
|
const scw = await import('./node_modules/scu-web-components/dist/scw.js');
|
|
15
|
-
scw.defineComponents(
|
|
16
|
-
components: [], // list of components you want, not using "components" argument will pull in all components
|
|
17
|
-
suffix: '', // for versioned components. "tst" would turn scw-link into scw-link-tst
|
|
18
|
-
assetsRuntime : true // for browser imports, will load assets lazily versus Base64ing into bundle
|
|
19
|
-
});
|
|
14
|
+
scw.defineComponents();
|
|
20
15
|
</script>
|
|
21
16
|
<link rel="stylesheet" href="./node_modules/scu-web-components/dist/scw.css" />
|
|
22
|
-
|
|
17
|
+
```
|
|
18
|
+
```html
|
|
23
19
|
<scw-link aria-label="Click Me"></scw-link>
|
|
24
20
|
```
|
|
25
21
|
|
|
26
|
-
## Reference
|
|
27
|
-
A quick way to access the reference can be created using http-server via
|
|
22
|
+
## View Reference
|
|
23
|
+
A quick way to access the design system reference can be created using http-server via
|
|
28
24
|
the package.json file
|
|
29
25
|
```bash
|
|
30
26
|
npm i http-server
|
|
@@ -35,13 +31,21 @@ npm i http-server
|
|
|
35
31
|
},
|
|
36
32
|
```
|
|
37
33
|
|
|
38
|
-
##
|
|
34
|
+
## Arguments
|
|
35
|
+
```html
|
|
36
|
+
<script type="module">
|
|
37
|
+
const scw = await import('./node_modules/scu-web-components/dist/scw.js');
|
|
38
|
+
scw.defineComponents({
|
|
39
|
+
components: [], // list of components you want, not using "components" argument will pull in all components
|
|
40
|
+
assetsRuntime : true // defaults true. Will load assets lazily versus Base64ing into bundle
|
|
41
|
+
suffix: '', // Experimental...for modular components. "tst" would turn scw-link into scw-link-tst
|
|
42
|
+
});
|
|
43
|
+
</script>
|
|
44
|
+
```
|
|
39
45
|
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
7 add to scu-components-custom.ts
|
|
47
|
-
8 add to index.ts
|
|
46
|
+
## New Component Checklist
|
|
47
|
+
1. Create component javascript ( src/[comp]/[comp].ts )
|
|
48
|
+
1. Create component scss ( src/[comp]/[comp].scss )
|
|
49
|
+
1. Create component reference ( src/[comp]/[comp].json )
|
|
50
|
+
1. Tests ( src/[comp]/tests/[comp].test.ts )
|
|
51
|
+
1. add to scu-components.ts
|