lookbook 1.0.0.rc.3 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f64c997d49feb8abebcde5278b87487c2e6560325e5f36c849b2f1897e8c749e
4
- data.tar.gz: d6d230272a15c2b3685da778e3b174300c5a40845f9b3819dba676c66f78904e
3
+ metadata.gz: 5617d397419ae8b9e95fa6c53ceb94dd3a7dffe83ea1fae0f643f17f6c15b995
4
+ data.tar.gz: 1fb037740def1192fa5aa9d0c076419dc06ed629996e7cc82ed741e7aefa000f
5
5
  SHA512:
6
- metadata.gz: 5cae26841a60c692b5f762b77ad5b6ca38cba5164da39b38f8e026b720a9289300469e6f50d8b7e90e7c8135dcae93443650ae4a6861c5e29ea7b527cdd6e6ee
7
- data.tar.gz: d59f0142b41eb72a82997a61a479937cf91ac2cf3adffdfd7e28f0fa9e9af6dacc0f106ce8db5afc9431b5b7278afb00fea3498859e4411b563cd67a47342c14
6
+ metadata.gz: a5710f8a40f7594bc4d9ac3347ca8c04102f708b50c21d96d1695b26ab4d6ccc23436e1288cea7d43516264260c31f091530cb15d3ea144707d2ae280442c333
7
+ data.tar.gz: 1bfdcf6ce5bb68e2af399b5920ec821a73057e77aaf4732216da498b1745c5c8eb15b220ce56115dd8c14d757febe75315c2620c6c6c929b3e973d001a5b7797
data/README.md CHANGED
@@ -1,83 +1,52 @@
1
- # Lookbook v1.0
1
+ # Lookbook
2
2
 
3
3
  <div>
4
4
  <a href="https://rubygems.org/gems/lookbook"><img src="https://img.shields.io/gem/v/lookbook?include_prereleases" alt="Gem version"></a>
5
- <img src="https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml/badge.svg?branch=v1.0-beta" alt="CI status">
5
+ <a href="https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml"><img src="https://github.com/allmarkedup/lookbook/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI status"></a>
6
6
  </div>
7
7
  <br>
8
8
 
9
- > **This is the Lookbook v1.0 BETA development branch.**<br>
10
- >_For code and documentation for the current stable release see the [main branch](https://github.com/allmarkedup/lookbook/tree/main)._
9
+ A tool to help develop, test and document [ViewComponents](https://viewcomponent.org/) in isolation.
11
10
 
11
+ ## Documentation
12
12
 
13
- ## Get started
13
+ **Lookbook (v1.x)** documentation: **[https://lookbook.build](https://lookbook.build)**
14
14
 
15
- If you are already using Lookbook in your project, just update the Lookbook gem to the latest beta release and then head over to the [beta documentation site](https://beta.lookbook.build/) to read more about the new features.
15
+ > _Looking for v0.9.x docs? [Head over here](https://github.com/allmarkedup/lookbook/tree/0.9.x)._
16
16
 
17
- ```ruby
18
- gem "lookbook", ">= 1.0.0.beta.8"
19
- ```
20
17
 
21
- If you are **new to Lookbook** then check out the <a href="https://beta.lookbook.build/guide/quick-start/">v1.0 quick start guide</a> for more detailed instructions on installing Lookbook in your project
22
-
23
-
24
- <h4>Useful Resources</h4>
25
-
26
- * 👉 <a href="https://beta.lookbook.build/">v1.0 docs</a>
27
- * 👉 <a href="https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook">v1.0 demo app</a> <em>(The repo for the demo <a href="https://github.com/allmarkedup/lookbook-demo/tree/v1.0-beta">is here</a> if you want to dig in further)</em>
28
-
29
-
30
-
31
- ## Changes and new features in v1.0
32
-
33
- Lookbook v1.0 includes a completely re-written UI, many under-the hood improvements and a some exciting new customisation options.
34
-
35
- ### Frontend changes:
36
-
37
- * Completely re-written UI - now built with ViewComponents
38
- * New [UI themes and customisation options](https://beta.lookbook.build/guide/themes/)
39
- * Improved small-screen/mobile view
40
- * Debug menu
41
- * ...and many other small visual and usability improvements
42
-
43
- ### New options for extending Lookbook:
44
-
45
- * Define [custom tags](https://beta.lookbook.build/guide/extend/tags/) for preview file annotations
46
- * Create [your own tab panels](https://beta.lookbook.build/guide/extend/panels/) - with complete control over content/layout and access to all Lookbook data
47
- * Use [lifecycle hooks](https://beta.lookbook.build/guide/extend/hooks/) to run your own code when Lookbook starts up, when files change or at shutdown
48
-
49
- ### Other changes
50
-
51
- * 'Workbench' app for developing Lookbook's UI components in Lookbook
52
- * New Rspec-based test suite and dummy app
53
- * All new documentation site built using [Bridgetown](https://www.bridgetownrb.com/)
18
+ ## Demo
54
19
 
20
+ **Online Demo:** [https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook](https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook)
55
21
 
56
22
  [![Lookbook UI](.github/assets/lookbook_screenshot_v1.0_beta.png)](https://lookbook-demo-app-v1-0-beta.herokuapp.com/lookbook/)
57
23
 
58
- ## Workbench
59
24
 
60
- As of this release, Lookbook's UI is itself built using ViewComponent components. To help with development it is possible to preview these components (in a Lookbook instance!) by running the included 'Workbench" app, as follows:
25
+ ## Development
26
+
27
+ Lookbook's UI is itself built using ViewComponents. To preview these components in a Lookbook instance you can run the included `workbench` app:
61
28
 
62
29
  1. Clone this repo
63
30
  2. Install dependencies: `bundle install & npm install`
64
- 3. Start the Workbench: `foreman start`
65
- 4. Open http://localhost:4545 in your browser to view the Workbench
31
+ 3. Start the app: `bin/workbench`
32
+ 4. Visit http://localhost:4545/lookbook to view the Lookbook instance
33
+
34
+ The `workbench` app will be started in development mode and any changes to Lookbook's views or assets will immediately be reflected in the UI.
66
35
 
67
- This will start the Workbench app in development mode and any changes to Lookbooks views or assets will immediately be visible in the UI.
36
+ ### Docs site
68
37
 
38
+ The [Lookbook docs site](https://lookbook.build) is built using [Bridgetown](https://www.bridgetownrb.com/) and the source files can be found in the `./docs` directory.
69
39
 
70
- ## Running tests
40
+ To see a local version of the site run `bin/docs` from the root of this repo and then visit http://localhost:4000 in your browser.
71
41
 
72
- The test suite is in the process of being completely overhauled.
42
+ ### Testing
73
43
 
74
- Tests are now written using RSpec and the system now uses [Combustion](https://github.com/pat/combustion) under the hood.
44
+ Lookbook uses RSpec for testing.
75
45
 
76
- - Tests can be run using the `rake lookbook:test` or `bundle exec rspec` commands.
77
- - The dummy app that the tests are being run against can be viewed by running the `rake lookbook:test:serve` command and then browsing to http://localhost:9292/lookbook
46
+ Tests can be run using the `rake spec` or `bundle exec rspec` commands.
78
47
 
48
+ The dummy app that the tests are being run against can be viewed by running the `bin/dummy` command and then browsing to http://localhost:9292/lookbook
79
49
 
80
- ---
81
50
 
82
51
  ## License
83
52
 
@@ -1,3 +1,3 @@
1
1
  module Lookbook
2
- VERSION = "1.0.0.rc.3"
2
+ VERSION = "1.0.0"
3
3
  end
@@ -7701,7 +7701,7 @@ function $5439cede634b2921$var$toCamel(s) {
7701
7701
  }
7702
7702
 
7703
7703
 
7704
- var $730b795bb0498251$exports = {};
7704
+ var $6ff830cc0b6487a5$exports = {};
7705
7705
  var $cbd28b10fa9798c7$exports = {};
7706
7706
 
7707
7707
  $parcel$defineInteropFlag($cbd28b10fa9798c7$exports);
@@ -11364,6 +11364,39 @@ function $99486586f6691564$export$2e2bcd8739ae039() {
11364
11364
  }
11365
11365
 
11366
11366
 
11367
+ var $e398acaded942bbe$exports = {};
11368
+
11369
+ $parcel$defineInteropFlag($e398acaded942bbe$exports);
11370
+
11371
+ $parcel$export($e398acaded942bbe$exports, "default", () => $e398acaded942bbe$export$2e2bcd8739ae039);
11372
+
11373
+ function $e398acaded942bbe$export$2e2bcd8739ae039(targetSelector) {
11374
+ return {
11375
+ width: 0,
11376
+ height: 0,
11377
+ resizing: false,
11378
+ target: null,
11379
+ init () {
11380
+ this.target = document.querySelector(targetSelector);
11381
+ if (this.target) {
11382
+ this.width = Math.round(this.target.clientWidth);
11383
+ this.height = Math.round(this.target.clientHeight);
11384
+ this.createObserver();
11385
+ }
11386
+ },
11387
+ createObserver () {
11388
+ if (this.target) this.observer = (0, $9930d46698775b42$export$a2214cc2adb2dc44)(document.querySelector(targetSelector), ({ width: width , height: height })=>{
11389
+ this.width = width;
11390
+ this.height = height;
11391
+ });
11392
+ },
11393
+ tearDown () {
11394
+ if (this.observer) this.observer.disconnect();
11395
+ }
11396
+ };
11397
+ }
11398
+
11399
+
11367
11400
  var $47a1c62621be0c54$exports = {};
11368
11401
 
11369
11402
  $parcel$defineInteropFlag($47a1c62621be0c54$exports);
@@ -11420,39 +11453,6 @@ function $47a1c62621be0c54$export$2e2bcd8739ae039() {
11420
11453
  }
11421
11454
 
11422
11455
 
11423
- var $e398acaded942bbe$exports = {};
11424
-
11425
- $parcel$defineInteropFlag($e398acaded942bbe$exports);
11426
-
11427
- $parcel$export($e398acaded942bbe$exports, "default", () => $e398acaded942bbe$export$2e2bcd8739ae039);
11428
-
11429
- function $e398acaded942bbe$export$2e2bcd8739ae039(targetSelector) {
11430
- return {
11431
- width: 0,
11432
- height: 0,
11433
- resizing: false,
11434
- target: null,
11435
- init () {
11436
- this.target = document.querySelector(targetSelector);
11437
- if (this.target) {
11438
- this.width = Math.round(this.target.clientWidth);
11439
- this.height = Math.round(this.target.clientHeight);
11440
- this.createObserver();
11441
- }
11442
- },
11443
- createObserver () {
11444
- if (this.target) this.observer = (0, $9930d46698775b42$export$a2214cc2adb2dc44)(document.querySelector(targetSelector), ({ width: width , height: height })=>{
11445
- this.width = width;
11446
- this.height = height;
11447
- });
11448
- },
11449
- tearDown () {
11450
- if (this.observer) this.observer.disconnect();
11451
- }
11452
- };
11453
- }
11454
-
11455
-
11456
11456
  var $e1f51f020443edd4$exports = {};
11457
11457
 
11458
11458
  $parcel$defineInteropFlag($e1f51f020443edd4$exports);
@@ -13210,11 +13210,11 @@ function $6d64716f0b34fdf4$export$2e2bcd8739ae039(store) {
13210
13210
  }
13211
13211
 
13212
13212
 
13213
- $730b795bb0498251$exports = {
13213
+ $6ff830cc0b6487a5$exports = {
13214
13214
  "button": $cbd28b10fa9798c7$exports,
13215
13215
  "code": $99486586f6691564$exports,
13216
- "copy_button": $47a1c62621be0c54$exports,
13217
13216
  "dimensions_display": $e398acaded942bbe$exports,
13217
+ "copy_button": $47a1c62621be0c54$exports,
13218
13218
  "embed": $e1f51f020443edd4$exports,
13219
13219
  "filter": $e9904a14dabf652d$exports,
13220
13220
  "icon": $36506012e0c6e9e3$exports,
@@ -13367,7 +13367,7 @@ const $d73574cc5e9b9e72$var$prefix = window.APP_NAME;
13367
13367
  // Components
13368
13368
  (0, $caa9439642c6336c$export$2e2bcd8739ae039).data("app", (0, $d709d0f4027033b2$export$2e2bcd8739ae039));
13369
13369
  [
13370
- $730b795bb0498251$exports,
13370
+ $6ff830cc0b6487a5$exports,
13371
13371
  $e4eab7529959b73b$exports,
13372
13372
  $4979d2d897a1c01f$exports
13373
13373
  ].forEach((scripts)=>{