playbook-ui 14.6.1 → 14.6.2-alpha.PLAY1538READMEroot4251

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.
@@ -6,8 +6,8 @@
6
6
  "_lib-D-mTv-kp.js"
7
7
  ]
8
8
  },
9
- "__weekday_stacked-BR99DW9T.js": {
10
- "file": "chunks/_weekday_stacked-BR99DW9T.js",
9
+ "__weekday_stacked-Dh3OU4s8.js": {
10
+ "file": "chunks/_weekday_stacked-Dh3OU4s8.js",
11
11
  "name": "_weekday_stacked",
12
12
  "imports": [
13
13
  "_lazysizes-B7xYodB-.js",
@@ -44,7 +44,7 @@
44
44
  "isEntry": true,
45
45
  "imports": [
46
46
  "_pb_form_validation-BkWGwJsl.js",
47
- "__weekday_stacked-BR99DW9T.js",
47
+ "__weekday_stacked-Dh3OU4s8.js",
48
48
  "_lazysizes-B7xYodB-.js",
49
49
  "__typeahead-BV_n6U5W.js",
50
50
  "_lib-D-mTv-kp.js"
@@ -79,7 +79,7 @@
79
79
  "src": "entrypoints/playbook.js",
80
80
  "isEntry": true,
81
81
  "imports": [
82
- "__weekday_stacked-BR99DW9T.js",
82
+ "__weekday_stacked-Dh3OU4s8.js",
83
83
  "_lazysizes-B7xYodB-.js",
84
84
  "__typeahead-BV_n6U5W.js",
85
85
  "_lib-D-mTv-kp.js"
package/dist/README.md ADDED
@@ -0,0 +1,94 @@
1
+ [![npm version](https://badge.fury.io/js/playbook-ui.svg)](https://badge.fury.io/js/playbook-ui)
2
+ [![Gem Version](https://badge.fury.io/rb/playbook_ui.svg)](https://badge.fury.io/rb/playbook_ui)
3
+
4
+ # Playbook Design System
5
+
6
+ Playbook is the first design system built for both Rails & React interfaces. Inspired by [Velocity](https://www.invisionapp.com/inside-design/design-resources/design-system-dashboard-ui-kit/), Playbook takes a modern design approach and applies it in a way that makes it easy to support bleeding edge or legacy systems. Playbook is built & maintained by the User Experience & Development teams at [Power Home Remodeling](https://www.techatpower.com/), the largest home remodeler in the US.
7
+
8
+ ## Development
9
+
10
+ ### Requirements
11
+
12
+ - [asdf](https://github.com/asdf-vm/asdf)
13
+
14
+ ### Getting Started and Running Playbook for Development
15
+
16
+ 1. After cloning the repo, you should have the following nested folders among other files. It will be important to pay attention to which folder we are in as we get playbook running:
17
+ ```
18
+ playbook
19
+ │ playbook
20
+ │ playbook-website
21
+ ```
22
+ 1. Ensure your installed version of `bundler` is the same as the `BUNDLED WITH` section found in [Gemfile.lock](./Gemfile.lock). You can check the version you have by running `bundle -v`.
23
+
24
+ 1. From the root directory, run `./setup.sh`
25
+
26
+ 1. From the top-level playbook folder run `yarn start-dev` This may take a little while.
27
+ 1. Once you see the "compiled successfully" message in your terminal, navigate to [http://localhost:3000](http://localhost:3000) and you should see the playbook website.
28
+
29
+ ### Post Installation Startup
30
+
31
+ Use `./run.sh` to run the application in one step. This will handle dependency updates then start the server. Helpful for fast start-up without bootstrapping especially when switching branches. 🚀
32
+
33
+ ### Running Library Tests
34
+
35
+ 1. `cd playbook && ./test.sh`
36
+
37
+ ---
38
+
39
+ ## Additional Resources
40
+
41
+ ### Adding NPM Dependencies
42
+
43
+ 1. You need to be working in `playbook/playbook` or `playbook/playbook-website` subdirectory
44
+ 1. run `yarn workspace playbook-website add <lib name>` to add to the website
45
+ 1. run `yarn workspace playbook-ui add <lib name>` to add to the kit source
46
+ 1. run `yarn workspace playbook-project add <lib name>` to add to the main project
47
+
48
+ ### Upgrading between versions
49
+
50
+ See [docs/upgrade-guide](./upgrade-guide)
51
+
52
+ ### Releases
53
+
54
+ * [Playbook Releases](https://github.com/powerhome/playbook/wiki/Playbook-Releases)
55
+
56
+ ### Development Environment
57
+
58
+ * [Common Errors & Solutions](https://github.com/powerhome/playbook/wiki/Common-Errors-&-Solutions)
59
+
60
+ ### Building Playbook Kits
61
+
62
+ * [Generating a Kit](https://github.com/powerhome/playbook/wiki/Generating-a-Kit)
63
+ * [Rails Kit](https://github.com/powerhome/playbook/wiki/Rails-Kit)
64
+ * [Rails Kit Helpers](https://github.com/powerhome/playbook/wiki/Rails-Kit-Helpers)
65
+ * [Using a Kit within a Kit](https://github.com/powerhome/playbook/wiki/Using-a-Kit-within-a-Kit)
66
+ * [Understanding Rails Kit HTML Wrapper](https://github.com/powerhome/playbook/wiki/Understanding-Rails-Kit-HTML-Wrapper)
67
+ * [Kit Stylesheet](https://github.com/powerhome/playbook/wiki/Kit-Stylesheet)
68
+
69
+ ### Testing Playbook Kits Locally
70
+
71
+ #### Testing React Kits locally
72
+
73
+ 1. From inside the `playbook-ui` directory, run `yarn link`;
74
+ 1. From Inside the project you want to test with `playbook-ui`, run `yarn link playbook-ui`;
75
+ 1. Rebuild the project now using this version of `playbook-ui`;
76
+ 1. Test all the things!
77
+ 1. When finished, from inside the project you were testing with `playbook-ui`, run `yarn unlink playbook-ui`;
78
+ 1. From Inside the `playbook-ui` directory, run `yarn unlink`;
79
+
80
+ #### Jest & React-Testing-Library for Writing Tests
81
+
82
+ We are currently backfilling test cases for React kit test coverage using Jest and React Testing Library. More additions and enhancements
83
+ to the testing libraries are currently in the works. In the meantime, please take a look at these resources:
84
+
85
+ - https://github.com/testing-library/jest-dom#usage for usage and examples
86
+ - https://jestjs.io/docs/en/using-matchers
87
+
88
+ When a new kit is generated, a placeholder React kit test will also be created. You can run all the tests with `yarn test`.
89
+
90
+ ### Important Note
91
+
92
+ Keep in mind: Styles are brought in from playbook through the rails gem, so you will not be able to test scss updates with yarn linking.
93
+
94
+ The gem & npm package is available as open source under the terms of the [ISC License](https://opensource.org/licenses/ISC).