@scania/tegel 0.0.1-beta.4 → 0.0.1-beta.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.
Files changed (36) hide show
  1. package/dist/cjs/loader.cjs.js +1 -1
  2. package/dist/cjs/tegel.cjs.js +1 -1
  3. package/dist/collection/collection-manifest.json +2 -2
  4. package/dist/components/dropdown-option.js +0 -1
  5. package/dist/components/dropdown.js +0 -1
  6. package/dist/components/icon.js +0 -1
  7. package/dist/components/sdds-accordion-item.js +0 -1
  8. package/dist/components/sdds-accordion.js +0 -1
  9. package/dist/components/sdds-badges.js +0 -1
  10. package/dist/components/sdds-button.js +0 -1
  11. package/dist/components/sdds-datetime.js +0 -1
  12. package/dist/components/sdds-dropdown-filter.js +0 -1
  13. package/dist/components/sdds-header-cell.js +0 -1
  14. package/dist/components/sdds-inline-tabs-fullbleed.js +0 -1
  15. package/dist/components/sdds-inline-tabs.js +0 -1
  16. package/dist/components/sdds-modal.js +0 -1
  17. package/dist/components/sdds-navigation-tabs.js +0 -1
  18. package/dist/components/sdds-popover-canvas.js +0 -1
  19. package/dist/components/sdds-popover-menu.js +0 -1
  20. package/dist/components/sdds-slider.js +0 -1
  21. package/dist/components/sdds-spinner.js +0 -1
  22. package/dist/components/sdds-table-body-row-expandable.js +0 -1
  23. package/dist/components/sdds-table-body.js +0 -1
  24. package/dist/components/sdds-table-footer.js +0 -1
  25. package/dist/components/sdds-table-header.js +0 -1
  26. package/dist/components/sdds-table-toolbar.js +0 -1
  27. package/dist/components/sdds-table.js +0 -1
  28. package/dist/components/sdds-textarea.js +0 -1
  29. package/dist/components/sdds-textfield.js +0 -1
  30. package/dist/components/sdds-tooltip.js +0 -1
  31. package/dist/components/table-body-cell.js +0 -1
  32. package/dist/components/table-body-row.js +0 -1
  33. package/dist/esm/loader.js +1 -1
  34. package/dist/esm/tegel.js +1 -1
  35. package/package.json +3 -3
  36. package/readme.md +135 -0
@@ -5,7 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
5
5
  const index = require('./index-e1c79686.js');
6
6
 
7
7
  /*
8
- Stencil Client Patch Esm v2.20.0 | MIT Licensed | https://stenciljs.com
8
+ Stencil Client Patch Esm v2.19.2 | MIT Licensed | https://stenciljs.com
9
9
  */
10
10
  const patchEsm = () => {
11
11
  return index.promiseResolve();
@@ -3,7 +3,7 @@
3
3
  const index = require('./index-e1c79686.js');
4
4
 
5
5
  /*
6
- Stencil Client Patch Browser v2.20.0 | MIT Licensed | https://stenciljs.com
6
+ Stencil Client Patch Browser v2.19.2 | MIT Licensed | https://stenciljs.com
7
7
  */
8
8
  const patchBrowser = () => {
9
9
  const importMeta = (typeof document === 'undefined' ? new (require('u' + 'rl').URL)('file:' + __filename).href : (document.currentScript && document.currentScript.src || new URL('tegel.cjs.js', document.baseURI).href));
@@ -32,8 +32,8 @@
32
32
  ],
33
33
  "compiler": {
34
34
  "name": "@stencil/core",
35
- "version": "2.20.0",
36
- "typescriptVersion": "4.8.4"
35
+ "version": "2.19.2",
36
+ "typescriptVersion": "4.7.4"
37
37
  },
38
38
  "collections": [],
39
39
  "bundles": []
@@ -96,6 +96,5 @@ function defineCustomElement() {
96
96
  break;
97
97
  } });
98
98
  }
99
- defineCustomElement();
100
99
 
101
100
  export { DropdownOption as D, defineCustomElement as d };
@@ -292,6 +292,5 @@ function defineCustomElement() {
292
292
  break;
293
293
  } });
294
294
  }
295
- defineCustomElement();
296
295
 
297
296
  export { Dropdown as D, defineCustomElement as d };
@@ -54,6 +54,5 @@ function defineCustomElement() {
54
54
  break;
55
55
  } });
56
56
  }
57
- defineCustomElement();
58
57
 
59
58
  export { Icon as I, defineCustomElement as d };
@@ -53,7 +53,6 @@ function defineCustomElement$1() {
53
53
  break;
54
54
  } });
55
55
  }
56
- defineCustomElement$1();
57
56
 
58
57
  const SddsAccordionItem = AccordionItem;
59
58
  const defineCustomElement = defineCustomElement$1;
@@ -31,7 +31,6 @@ function defineCustomElement$1() {
31
31
  break;
32
32
  } });
33
33
  }
34
- defineCustomElement$1();
35
34
 
36
35
  const SddsAccordion = Accordion;
37
36
  const defineCustomElement = defineCustomElement$1;
@@ -69,7 +69,6 @@ function defineCustomElement$1() {
69
69
  break;
70
70
  } });
71
71
  }
72
- defineCustomElement$1();
73
72
 
74
73
  const SddsBadges = SddsBadges$1;
75
74
  const defineCustomElement = defineCustomElement$1;
@@ -51,7 +51,6 @@ function defineCustomElement$1() {
51
51
  break;
52
52
  } });
53
53
  }
54
- defineCustomElement$1();
55
54
 
56
55
  const SddsButton = SddsButton$1;
57
56
  const defineCustomElement = defineCustomElement$1;
@@ -83,7 +83,6 @@ function defineCustomElement$1() {
83
83
  break;
84
84
  } });
85
85
  }
86
- defineCustomElement$1();
87
86
 
88
87
  const SddsDatetime = Datetime;
89
88
  const defineCustomElement = defineCustomElement$1;
@@ -131,7 +131,6 @@ function defineCustomElement$1() {
131
131
  break;
132
132
  } });
133
133
  }
134
- defineCustomElement$1();
135
134
 
136
135
  const SddsDropdownFilter = DropdownFilter;
137
136
  const defineCustomElement = defineCustomElement$1;
@@ -166,7 +166,6 @@ function defineCustomElement$1() {
166
166
  break;
167
167
  } });
168
168
  }
169
- defineCustomElement$1();
170
169
 
171
170
  const SddsHeaderCell = TableHeaderCell;
172
171
  const defineCustomElement = defineCustomElement$1;
@@ -108,7 +108,6 @@ function defineCustomElement$1() {
108
108
  break;
109
109
  } });
110
110
  }
111
- defineCustomElement$1();
112
111
 
113
112
  const SddsInlineTabsFullbleed = InlineTabsFullbleed;
114
113
  const defineCustomElement = defineCustomElement$1;
@@ -228,7 +228,6 @@ function defineCustomElement$1() {
228
228
  break;
229
229
  } });
230
230
  }
231
- defineCustomElement$1();
232
231
 
233
232
  const SddsInlineTabs = InlineTabs;
234
233
  const defineCustomElement = defineCustomElement$1;
@@ -62,7 +62,6 @@ function defineCustomElement$1() {
62
62
  break;
63
63
  } });
64
64
  }
65
- defineCustomElement$1();
66
65
 
67
66
  const SddsModal = Modal;
68
67
  const defineCustomElement = defineCustomElement$1;
@@ -106,7 +106,6 @@ function defineCustomElement$1() {
106
106
  break;
107
107
  } });
108
108
  }
109
- defineCustomElement$1();
110
109
 
111
110
  const SddsNavigationTabs = NavigationTabs;
112
111
  const defineCustomElement = defineCustomElement$1;
@@ -90,7 +90,6 @@ function defineCustomElement$1() {
90
90
  break;
91
91
  } });
92
92
  }
93
- defineCustomElement$1();
94
93
 
95
94
  const SddsPopoverCanvas = PopoverCanvas;
96
95
  const defineCustomElement = defineCustomElement$1;
@@ -89,7 +89,6 @@ function defineCustomElement$1() {
89
89
  break;
90
90
  } });
91
91
  }
92
- defineCustomElement$1();
93
92
 
94
93
  const SddsPopoverMenu = PopoverMenu;
95
94
  const defineCustomElement = defineCustomElement$1;
@@ -359,7 +359,6 @@ function defineCustomElement$1() {
359
359
  break;
360
360
  } });
361
361
  }
362
- defineCustomElement$1();
363
362
 
364
363
  const SddsSlider = Slider;
365
364
  const defineCustomElement = defineCustomElement$1;
@@ -30,7 +30,6 @@ function defineCustomElement$1() {
30
30
  break;
31
31
  } });
32
32
  }
33
- defineCustomElement$1();
34
33
 
35
34
  const SddsSpinner = Spinner;
36
35
  const defineCustomElement = defineCustomElement$1;
@@ -97,7 +97,6 @@ function defineCustomElement$1() {
97
97
  break;
98
98
  } });
99
99
  }
100
- defineCustomElement$1();
101
100
 
102
101
  const SddsTableBodyRowExpandable = TableBodyRowExpandable;
103
102
  const defineCustomElement = defineCustomElement$1;
@@ -330,7 +330,6 @@ function defineCustomElement$1() {
330
330
  break;
331
331
  } });
332
332
  }
333
- defineCustomElement$1();
334
333
 
335
334
  const SddsTableBody = TableBody;
336
335
  const defineCustomElement = defineCustomElement$1;
@@ -189,7 +189,6 @@ function defineCustomElement$1() {
189
189
  break;
190
190
  } });
191
191
  }
192
- defineCustomElement$1();
193
192
 
194
193
  const SddsTableFooter = TableFooter;
195
194
  const defineCustomElement = defineCustomElement$1;
@@ -118,7 +118,6 @@ function defineCustomElement$1() {
118
118
  break;
119
119
  } });
120
120
  }
121
- defineCustomElement$1();
122
121
 
123
122
  const SddsTableHeader = TableHeaderRow;
124
123
  const defineCustomElement = defineCustomElement$1;
@@ -81,7 +81,6 @@ function defineCustomElement$1() {
81
81
  break;
82
82
  } });
83
83
  }
84
- defineCustomElement$1();
85
84
 
86
85
  const SddsTableToolbar = TableToolbar;
87
86
  const defineCustomElement = defineCustomElement$1;
@@ -85,7 +85,6 @@ function defineCustomElement$1() {
85
85
  break;
86
86
  } });
87
87
  }
88
- defineCustomElement$1();
89
88
 
90
89
  const SddsTable = Table;
91
90
  const defineCustomElement = defineCustomElement$1;
@@ -83,7 +83,6 @@ function defineCustomElement$1() {
83
83
  break;
84
84
  } });
85
85
  }
86
- defineCustomElement$1();
87
86
 
88
87
  const SddsTextarea = Textarea;
89
88
  const defineCustomElement = defineCustomElement$1;
@@ -104,7 +104,6 @@ function defineCustomElement$1() {
104
104
  break;
105
105
  } });
106
106
  }
107
- defineCustomElement$1();
108
107
 
109
108
  const SddsTextfield = Textfield;
110
109
  const defineCustomElement = defineCustomElement$1;
@@ -109,7 +109,6 @@ function defineCustomElement$1() {
109
109
  break;
110
110
  } });
111
111
  }
112
- defineCustomElement$1();
113
112
 
114
113
  const SddsTooltip = Tooltip;
115
114
  const defineCustomElement = defineCustomElement$1;
@@ -98,6 +98,5 @@ function defineCustomElement() {
98
98
  break;
99
99
  } });
100
100
  }
101
- defineCustomElement();
102
101
 
103
102
  export { TableBodyCell as T, defineCustomElement as d };
@@ -115,6 +115,5 @@ function defineCustomElement() {
115
115
  break;
116
116
  } });
117
117
  }
118
- defineCustomElement();
119
118
 
120
119
  export { TableBodyRow as T, defineCustomElement as d };
@@ -1,7 +1,7 @@
1
1
  import { p as promiseResolve, b as bootstrapLazy } from './index-b67b15a6.js';
2
2
 
3
3
  /*
4
- Stencil Client Patch Esm v2.20.0 | MIT Licensed | https://stenciljs.com
4
+ Stencil Client Patch Esm v2.19.2 | MIT Licensed | https://stenciljs.com
5
5
  */
6
6
  const patchEsm = () => {
7
7
  return promiseResolve();
package/dist/esm/tegel.js CHANGED
@@ -1,7 +1,7 @@
1
1
  import { p as promiseResolve, b as bootstrapLazy } from './index-b67b15a6.js';
2
2
 
3
3
  /*
4
- Stencil Client Patch Browser v2.20.0 | MIT Licensed | https://stenciljs.com
4
+ Stencil Client Patch Browser v2.19.2 | MIT Licensed | https://stenciljs.com
5
5
  */
6
6
  const patchBrowser = () => {
7
7
  const importMeta = import.meta.url;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scania/tegel",
3
- "version": "0.0.1-beta.4",
3
+ "version": "0.0.1-beta.6",
4
4
  "description": "Tegel - Scania's Digital Design System",
5
5
  "keywords": [
6
6
  "tegel",
@@ -13,7 +13,7 @@
13
13
  "url": "https://github.com/scania-digital-design-system/sdds/issues"
14
14
  },
15
15
  "main": "dist/index.cjs.js",
16
- "module": "./dist/components/index.js",
16
+ "module": "dist/index.js",
17
17
  "es2015": "dist/esm/index.mjs",
18
18
  "es2017": "dist/esm/index.mjs",
19
19
  "types": "dist/types/index.d.ts",
@@ -47,7 +47,7 @@
47
47
  },
48
48
  "dependencies": {
49
49
  "@popperjs/core": "^2.11.6",
50
- "@stencil/core": "^2.20.0",
50
+ "@stencil/core": "^2.13.0",
51
51
  "@storybook/addon-google-analytics": "^6.2.9",
52
52
  "concurrently": "^7.4.0",
53
53
  "dotenv": "^16.0.3",
package/readme.md CHANGED
@@ -15,6 +15,141 @@ Check out [Tegel Design System](https://tegel.scania.com/) for implementation an
15
15
 
16
16
  - Installation: [https://tegel.scania.com/development/getting-started-development/installation](https://tegel.scania.com/development/getting-started-development/installation)
17
17
 
18
+ ## React
19
+
20
+ ### Typescript
21
+
22
+ 1. Run `npm install @scania/tegel`
23
+ 2. src folder create a file called `register-webcomponents.ts`
24
+ 3. Paste the following into that file:
25
+ ```ts
26
+ import { defineCustomElements, JSX as LocalJSX } from '@scania/tegel/loader';
27
+ import { DetailedHTMLProps, HTMLAttributes } from 'react';
28
+
29
+ type StencilProps<T> = {
30
+ [P in keyof T]?: Omit<T[P], 'ref'> | HTMLAttributes<T>;
31
+ };
32
+
33
+ type ReactProps<T> = {
34
+ [P in keyof T]?: DetailedHTMLProps<HTMLAttributes<T[P]>, T[P]>;
35
+ };
36
+
37
+ type StencilToReact<T = LocalJSX.IntrinsicElements, U = HTMLElementTagNameMap> = StencilProps<T> &
38
+ ReactProps<U>;
39
+
40
+ declare global {
41
+ export namespace JSX {
42
+ interface IntrinsicElements extends StencilToReact { }
43
+ }
44
+ }
45
+
46
+ defineCustomElements(window)
47
+ ```
48
+ 4. In your index.tsx import `register-webcomponents.ts`
49
+ ```tsx
50
+ import React from 'react';
51
+ import ReactDOM from 'react-dom/client';
52
+ import './index.css';
53
+ import App from './App';
54
+ import reportWebVitals from './reportWebVitals';
55
+ import './register-webcomponents';
56
+
57
+ const root = ReactDOM.createRoot(
58
+ document.getElementById('root') as HTMLElement
59
+ );
60
+ root.render(
61
+ <React.StrictMode>
62
+ <App />
63
+ </React.StrictMode>
64
+ );
65
+
66
+ reportWebVitals();
67
+ ```
68
+ 5. In your global css file (usually `App.css`) import the tegel stylesheet.
69
+ ```css
70
+ @import url('@scania/tegel/dist/tegel/tegel.css');
71
+ ```
72
+
73
+ ### Javascript
74
+ 1. Run `npm install @scania/tegel`
75
+ 2. In your index.jsx define the custom components:
76
+ ```jsx
77
+ import React from 'react';
78
+ import ReactDOM from 'react-dom/client';
79
+ import './index.css';
80
+ import App from './App';
81
+ import reportWebVitals from './reportWebVitals';
82
+ import {defineCustomElements} from '@scania/tegel/loader'
83
+
84
+ const root = ReactDOM.createRoot(document.getElementById('root'));
85
+ root.render(
86
+ <React.StrictMode>
87
+ <App />
88
+ </React.StrictMode>
89
+ );
90
+
91
+ reportWebVitals();
92
+ defineCustomElements()
93
+ ```
94
+ 3. In your global css file (usually `App.css`) import the tegel stylesheet.
95
+ ```css
96
+ @import url('@scania/tegel/dist/tegel/tegel.css');
97
+ ```
98
+
99
+ ## Angular
100
+
101
+ 1. Run `npm install @scania/tegel`
102
+ 2. In your `main.ts` import and call the function `defineCustomElements()`:
103
+
104
+ ```ts
105
+ import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
106
+ import { defineCustomElements } from '@scania/tegel/loader'
107
+ import { AppModule } from './app/app.module';
108
+
109
+
110
+ platformBrowserDynamic().bootstrapModule(AppModule)
111
+ .catch(err => console.error(err));
112
+
113
+ defineCustomElements(window);
114
+ ```
115
+ 3. In your `app.module.ts` import `CUSTOM_ELEMENTS_SCHEMA`:
116
+ ```ts
117
+ import { BrowserModule } from '@angular/platform-browser';
118
+ import { AppComponent } from './app.component';
119
+
120
+ @NgModule({
121
+ declarations: [
122
+ AppComponent
123
+ ],
124
+ imports: [
125
+ BrowserModule
126
+ ],
127
+ providers: [],
128
+ bootstrap: [AppComponent],
129
+ schemas: [CUSTOM_ELEMENTS_SCHEMA]
130
+ })
131
+ export class AppModule { }
132
+ ```
133
+ 4. In your global css file (`styles.css`) import the tegel stylesheet.
134
+ ```css
135
+ @import url('@scania/tegel/dist/tegel/tegel.css');
136
+ ```
137
+
138
+ ## HTML
139
+
140
+ 1. Run `npm init` to generate a package.json
141
+ 2. Run `npm install @scania/tegel`
142
+ 3. Import the package and its style in your `<head>`:
143
+ ```html
144
+ <script type="module">
145
+ import { defineCustomElements } from "./node_modules/@scania/tegel/loader/index.es2017.js";
146
+ defineCustomElements();
147
+ </script>
148
+ <link rel="stylesheet" href="./node_modules/@scania/tegel/dist/tegel/tegel.css">
149
+ ```
150
+
151
+
152
+
18
153
 
19
154
  See all available components in the [Tegel Design System](https://tegel.scania.com/components/overview).
20
155