@bspk/ui-ngx 1.0.0 → 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.
Files changed (2) hide show
  1. package/README.md +18 -41
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,64 +1,41 @@
1
- # Ui
1
+ # Bespoke UI-NGX
2
2
 
3
- This project was generated using [Angular CLI](https://github.com/angular/angular-cli) version 20.3.0.
3
+ Bespoke UI NGX package contains all the angular components that are available for Anywhere Real Estate development teams.
4
4
 
5
- ## Code scaffolding
5
+ https://bspk.anywhere.re
6
6
 
7
- Angular CLI includes powerful code scaffolding tools. To generate a new component, run:
7
+ ## Installation
8
8
 
9
9
  ```bash
10
- ng generate component component-name
10
+ npm install @bspk/ui-ngx
11
11
  ```
12
12
 
13
- For a complete list of available schematics (such as `components`, `directives`, or `pipes`), run:
14
-
15
13
  ```bash
16
- ng generate --help
14
+ npm install --peer @bspk/styles @floating-ui/dom
17
15
  ```
18
16
 
19
- ## Building
17
+ ## Setup
20
18
 
21
- To build the library, run:
19
+ Ensure you your theme stylesheet from `@bspk/styles` and the base and color stylesheets.
22
20
 
23
- ```bash
24
- ng build ui
21
+ ```scss
22
+ @use '@bspk/styles/anywhere.css';
23
+ @use '@bspk/ui-ngx/src/styles/base';
24
+ @use '@bspk/ui-ngx/src/styles/colors';
25
25
  ```
26
26
 
27
- This command will compile your project, and the build artifacts will be placed in the `dist/` directory.
28
-
29
- ### Publishing the Library
30
-
31
- Once the project is built, you can publish your library by following these steps:
32
-
33
- 1. Navigate to the `dist` directory:
34
-
35
- ```bash
36
- cd dist/ui
37
- ```
27
+ ## Testing
38
28
 
39
- 2. Run the `npm publish` command to publish your library to the npm registry:
40
- ```bash
41
- npm publish
42
- ```
43
-
44
- ## Running unit tests
45
-
46
- To execute unit tests with the [Karma](https://karma-runner.github.io) test runner, use the following command:
29
+ To test all components
47
30
 
48
31
  ```bash
49
- ng test
32
+ npm run test
50
33
  ```
51
34
 
52
- ## Running end-to-end tests
53
-
54
- For end-to-end (e2e) testing, run:
35
+ To test a specific component
55
36
 
56
37
  ```bash
57
- ng e2e
38
+ npm run test <componentname>
58
39
  ```
59
40
 
60
- Angular CLI does not come with an end-to-end testing framework by default. You can choose one that suits your needs.
61
-
62
- ## Additional Resources
63
-
64
- For more information on using the Angular CLI, including detailed command references, visit the [Angular CLI Overview and Command Reference](https://angular.dev/tools/cli) page.
41
+ <!--- Copyright 2026 Anywhere Real Estate - CC BY 4.0 -->
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bspk/ui-ngx",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "peerDependencies": {
5
5
  "@angular/common": "^20.3.0",
6
6
  "@angular/core": "^20.3.0",