@nypl/design-system-react-components 0.28.0 → 1.0.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 CHANGED
@@ -8,6 +8,14 @@ Currently, this repo is in Prerelease. When it is released, this project will ad
8
8
 
9
9
  ## Prerelease
10
10
 
11
+ ## 1.0.0 (May 12, 2022)
12
+
13
+ This is the first stable release of the NYPL Reservoir Design System! We've been looking forward to this moment for over two years.
14
+
15
+ ### Updates
16
+
17
+ - Updates all links throughout the documentation to point to the new production URLs.
18
+
11
19
  ## 0.28.0 (May 9, 2022)
12
20
 
13
21
  ### Adds
package/README.md CHANGED
@@ -10,7 +10,7 @@ _Note: This library is still in beta. Until we release the stable `1.0.0` versio
10
10
 
11
11
  Storybook documentation
12
12
 
13
- - [Production - deployed to Github Pages](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/introduction--page)
13
+ - [Production - deployed to Github Pages](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/welcome--page)
14
14
  - [Development - deployed to Tugboat QA](https://development-6y1v6na1ceqnmojvc5akrm5ewys3cshs.tugboat.qa/?path=/story/introduction--page)
15
15
 
16
16
  | Table of Contents | |
@@ -194,7 +194,7 @@ The list of re-exported Chakra components can be found in the main [index.ts](/s
194
194
  Find more information about the Design System's internal use of Chakra to create and refactor components in the Storybook documentation page. The following two links have the same information but in different formats for your reading preference:
195
195
 
196
196
  - [MDX format](/src/docs/Chakra.stories.mdx)
197
- - [Storybook page](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/chakra-ui--page)
197
+ - [Storybook page](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/chakra-ui--page)
198
198
 
199
199
  Chakra was integrated into the Design System in version `0.25.0`. For those looking to update to a version greater than or equal `0.25.0`, check out our [Chakra Migration Guide](/CHAKRA_MIGRATION_GUIDE.md).
200
200
 
@@ -216,7 +216,7 @@ You can check out a working Codepen with unpkg [here](https://codepen.io/edwingu
216
216
 
217
217
  ## Storybook
218
218
 
219
- The Reservoir Design System leverages Storybook to document all the React components and style guidelines. The Storybook documentation can be found [here](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/introduction--page). For your convenience, the Reservoir Design System components have been organized into logical categories based on both form and function. Please refer to the COMPONENTS section in the Storybook sidebar.
219
+ The Reservoir Design System leverages Storybook to document all the React components and style guidelines. The Storybook documentation can be found [here](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/welcome--page). For your convenience, the Reservoir Design System components have been organized into logical categories based on both form and function. Please refer to the COMPONENTS section in the Storybook sidebar.
220
220
 
221
221
  ### Documentation Instances
222
222
 
@@ -224,7 +224,7 @@ There are currently two main instances of the Reservoir Design System Storybook
224
224
 
225
225
  **Production**
226
226
 
227
- The production Storybook documentation is deployed to [Github Pages](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/introduction--page). This is the main instance we use to share the latest stable release of the Reservoir Design System. This documentation site is deployed through [Github Actions](/.github/workflows/gh-pages.yml) only on merges to the `release` branch.
227
+ The production Storybook documentation is deployed to [Github Pages](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/welcome--page). This is the main instance we use to share the latest stable release of the Reservoir Design System. This documentation site is deployed through [Github Actions](/.github/workflows/gh-pages.yml) only on merges to the `release` branch.
228
228
 
229
229
  As of July, 2021, the Github Pages production site gets deployed every two weeks on the same schedule as npm releases.
230
230
 
@@ -261,13 +261,13 @@ To help consuming application developers understand which version of the DS is r
261
261
 
262
262
  ### Static Build
263
263
 
264
- There should be no need to run the static Storybook instance while actively developing -- it's used exclusively for building out the `gh-pages` environment and deploying it to [Github Pages](https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/introduction--page). In the event that you do run the static Storybook npm script, run:
264
+ There should be no need to run the static Storybook instance while actively developing -- it's used exclusively for building out the `gh-pages` environment and deploying it to [Github Pages](https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/story/welcome--page). In the event that you do run the static Storybook npm script, run:
265
265
 
266
266
  ```sh
267
- $ npm run build-storybook
267
+ $ npm run build-storybook:v1
268
268
  ```
269
269
 
270
- You can then view `/storybook-static/index.html` in your browser. _Make sure not to commit this directory_.
270
+ You can then view `/reservoir/v1/index.html` in your browser. _Make sure not to commit this directory_.
271
271
 
272
272
  ## Typescript Usage
273
273
 
@@ -3047,17 +3047,14 @@ var breakpoints = /*#__PURE__*/themeTools.createBreakpoints({
3047
3047
  });
3048
3048
 
3049
3049
  /**
3050
- * Colors taken from "../../styles/01-colors/*.scss"
3050
+ * All colors can be found in Storybook:
3051
+ * https://nypl.github.io/nypl-design-system/reservoir/v1/?path=/docs/style-guide-colors--page
3051
3052
  *
3052
- * All UI colors can be found in Storybook:
3053
- * https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/documentation-style-guide-colors--colors-utility
3054
- * and in Figma:
3055
- * https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=14989%3A37
3053
+ * All UI colors can be found in Figma:
3054
+ * https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=47083%3A27674
3056
3055
  *
3057
- * All Brand colors can be found in Storybook:
3058
- * https://nypl.github.io/nypl-design-system/storybook-static/?path=/story/documentation-style-guide-colors--colors-brand
3059
- * and in Figma:
3060
- * https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=15454%3A47007
3056
+ * All Brand colors can be found in Figma:
3057
+ * https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=15454%3A47007
3061
3058
  *
3062
3059
  * At the end of this file, there are objects that extend Chakra's default
3063
3060
  * color shade palette for individual colors. WE DO NOT RECOMMEND to use them