@telus-uds/components-web 2.0.0 → 2.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/CHANGELOG.md +15 -2
- package/README.md +40 -1
- package/component-docs.json +13484 -0
- package/lib/index.js +7 -0
- package/lib/utils/index.js +16 -2
- package/lib/utils/ssr.js +50 -0
- package/lib-module/index.js +1 -0
- package/lib-module/utils/index.js +3 -2
- package/lib-module/utils/ssr.js +41 -0
- package/package.json +8 -7
- package/src/index.js +2 -0
- package/src/utils/index.js +4 -1
- package/src/utils/ssr.js +37 -0
- package/types/BlockQuote.d.ts +16 -0
- package/types/Box.d.ts +38 -0
- package/types/BreadcrumbItem.d.ts +11 -0
- package/types/Breadcrumbs.d.ts +21 -0
- package/types/ComponentTypeWithForwardRef.d.ts +5 -0
- package/types/MultiSelectFilter.d.ts +27 -0
- package/types/QuantitySelector.d.ts +20 -0
- package/types/ReactNative.d.ts +256 -0
- package/types/Tooltip.d.ts +17 -0
- package/types/TooltipButton.d.ts +12 -0
- package/types/Typography.d.ts +27 -0
- package/types/WebVideo.d.ts +17 -0
- package/types/common.d.ts +162 -0
- package/types/index.d.ts +244 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,12 +1,25 @@
|
|
|
1
1
|
# Change Log - @telus-uds/components-web
|
|
2
2
|
|
|
3
|
-
This log was last generated on
|
|
3
|
+
This log was last generated on Wed, 24 May 2023 01:36:34 GMT and should not be manually modified.
|
|
4
4
|
|
|
5
5
|
<!-- Start content -->
|
|
6
6
|
|
|
7
|
+
## 2.1.0
|
|
8
|
+
|
|
9
|
+
Wed, 24 May 2023 01:36:34 GMT
|
|
10
|
+
|
|
11
|
+
### Minor changes
|
|
12
|
+
|
|
13
|
+
- Adding SSRstyles (srikanthkhari@gmail.com)
|
|
14
|
+
- chore: update snapshot for list (samuraix221@hotmail.com)
|
|
15
|
+
- Bump @telus-uds/components-base to v1.43.0
|
|
16
|
+
- Bump @telus-uds/system-constants to v1.2.1
|
|
17
|
+
- Bump @telus-uds/system-theme-tokens to v2.26.1
|
|
18
|
+
- Bump @telus-uds/browserslist-config to v1.0.5
|
|
19
|
+
|
|
7
20
|
## 2.0.0
|
|
8
21
|
|
|
9
|
-
Fri, 19 May 2023 04:
|
|
22
|
+
Fri, 19 May 2023 04:57:25 GMT
|
|
10
23
|
|
|
11
24
|
### Major changes
|
|
12
25
|
|
package/README.md
CHANGED
|
@@ -1 +1,40 @@
|
|
|
1
|
-
# Web
|
|
1
|
+
# Web components
|
|
2
|
+
|
|
3
|
+
The UDS web components are a set of low level react components themed by UDS themes.
|
|
4
|
+
|
|
5
|
+
Refer to the [UDS monorepo README](https://github.com/telus/universal-design-system/#readme) for details.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```javascript
|
|
10
|
+
|
|
11
|
+
npm install @telus-uds/components-web
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
To ensure proper functionality, it is important to install the brand palette and theme since the components package does not include a default theme. For example, you can install the Telus brand palette and theme by running the following command:
|
|
15
|
+
|
|
16
|
+
```javascript
|
|
17
|
+
|
|
18
|
+
npm install @telus-uds/palette-allium @telus-uds/theme-allium
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
This will provide the necessary components, along with the corresponding palette and theme, for your project.
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
1. Export component as a named export from root
|
|
26
|
+
2. Wrap the UDS component in an BaseProvider
|
|
27
|
+
3. Include the BaseProvider provider once at the root of your application (e.g. in App.jsx)
|
|
28
|
+
|
|
29
|
+
```javascript
|
|
30
|
+
|
|
31
|
+
import { BaseProvider, Button } from '@telus-uds/components-web'
|
|
32
|
+
import alliumTheme from '@telus-uds/theme-allium'
|
|
33
|
+
...
|
|
34
|
+
<BaseProvider defaultTheme={alliumTheme}>
|
|
35
|
+
...
|
|
36
|
+
<Button onPress={() => {}}>Hello World!</Button>
|
|
37
|
+
...
|
|
38
|
+
</BaseProvider>
|
|
39
|
+
...
|
|
40
|
+
```
|