@ucalgary-design-system/core 1.0.1
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 +34 -0
- package/core.css +1 -0
- package/index.js +320 -0
- package/package.json +19 -0
package/README.md
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Core
|
|
2
|
+
|
|
3
|
+
This package provides general assets and styles for UCDS web components. It also includes the **BaseElement** web component that all UCDS web components extend.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install the component using npm:
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install @ucalgary-design-system/button
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Import the component into your application:
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import '@ucalgary-design-system/core';
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
When creating a new component, ensure that it extends the BaseElement.
|
|
22
|
+
For example:
|
|
23
|
+
```ts
|
|
24
|
+
@customElement('ucds-my-component')
|
|
25
|
+
export class MyComponent extends BaseElement { }
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Development
|
|
29
|
+
|
|
30
|
+
Build the component:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
npm run build
|
|
34
|
+
```
|