chore: GCDS Components Release v0.21.0 (#487)

* chore: GCDS Components Release * chore: update lerna.json and main changelog.md * chore: better format + details for name attribute changes * fix: PR feedback - update changelogs * fix: Add mssing web changelog * fix: pr feedback - fix format --------- Co-authored-by: sre-read-write[bot] <92993749+sre-read-write[bot]@users.noreply.github.com> Co-authored-by: Ethan Wallace <[email protected]>
cds-snc · May 8, 2024 · c75e54b · c75e54b
1 parent ee9438b
commit c75e54b
Show file tree

Hide file tree

Showing 13 changed files with 160 additions and 22 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,5 +1,5 @@
 {
-  "packages/angular": "0.20.0",
-  "packages/react": "0.20.0",
-  "packages/web": "0.20.0"
+  "packages/angular": "0.21.0",
+  "packages/react": "0.21.0",
+  "packages/web": "0.21.0"
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,92 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.21.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-v0.20.0...gcds-components-v0.21.0) (2024-05-08)
+
+### Breaking changes
+
+#### Transition to form-associated custom elements
+
+We've undertaken significant efforts to migrate our components to form-associated custom elements. GC Design System form components will now use the shadow DOM (document object model). The shadow DOM provides improved encapsulation and control over styling and lets form components integrate with native browser features for validation and accessibility. This feature depends on HTMLElement API attachInternals which is supported in most browsers.
+
+This change will require all form components to have the name attribute. Here's a list of the GC Design System components affected by the change:
+
+- File uploader (`gcds-file-uploader`)
+- Input (`gcds-input`)
+- Select (`gcds-select`)
+- Text area (`gcds-textarea`)
+
+##### Required changes for form components
+
+- Add a `name` attribute
+- Your code should look similar to the following:
+
+``` html
+<gcds-file-uploader name="" uploader-id="" label=""></gcds-file-uploader>
+<gcds-input name="" input-id="" label=""></gcds-input>
+<gcds-select name="" select-id="" label=""></gcds-select>
+<gcds-textarea name="" textarea-id="" label=""></gcds-textarea>
+```
+
+#### Shadow-dom
+
+The following components will be updated to now use the shadow DOM like other GC Design System components:
+
+- Pagination (`gcds-pagination`)
+- Search (`gcds-search`)
+- Signature (`gcds-signature`)
+
+#### Radio group
+
+As part of the transition, our `gcds-radio` component will be deprecated in favour of a new component `gcds-radio-group`. The radio group component allows for better (native HTML) form controls in a shadow DOM environment.
+
+##### Old implementation
+
+``` html
+<gcds-radio
+    radio-id="radio-1"
+    name="radio-example"
+    label="Label 1"
+    value="label-1"
+>
+  </gcds-radio>
+  <gcds-radio
+    radio-id="radio-2"
+    name="radio-example"
+    label="Label 2"
+    value="label-2"
+      >
+ </gcds-radio>
+ ```
+
+##### New implementation
+
+``` html
+<gcds-radio-group
+  name="radio-example"
+  options="[{ 
+      'id': 'radio-1',
+      'label': 'Label 1',
+      'value': 'label-1'}, {
+      'id': 'radio-2',
+      'label': 'Label 2',
+      'value': 'label-2'}]"
+>
+</gcds-radio-group>
+
+```
+
+
+### New Features
+
+* add tag prop to gcds-sr-only component ([#484](https://github.com/cds-snc/gcds-components/issues/484)) ([dfb7285](https://github.com/cds-snc/gcds-components/commit/dfb7285a14b477f4c4f71750e8b09d3ca5c193a9))
+* Component rewrites (form-associated, gcds-radio-group, CSS rewrites)  ([#486](https://github.com/cds-snc/gcds-components/issues/486)) ([ae05841](https://github.com/cds-snc/gcds-components/commit/ae0584172bb2219f907074c48235ae8b4f8719f5))
+
+
+### Bug Fixes
+
+* Update utility functions for more usability ([#495](https://github.com/cds-snc/gcds-components/issues/495)) ([a0e8fbb](https://github.com/cds-snc/gcds-components/commit/a0e8fbbf5ed8004f72f4e51ca2f2da4ef70a37ef))
+
 ## [0.20.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-v0.19.1...gcds-components-v0.20.0) (2024-03-14)
 
 

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "useNx": true,
-  "version": "0.20.0"
+  "version": "0.21.0"
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/angular/CHANGELOG.md b/packages/angular/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.21.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-angular-v0.20.0...gcds-components-angular-v0.21.0) (2024-05-08)
+
+
+### New Features
+
+* add tag prop to gcds-sr-only component ([#484](https://github.com/cds-snc/gcds-components/issues/484)) ([dfb7285](https://github.com/cds-snc/gcds-components/commit/dfb7285a14b477f4c4f71750e8b09d3ca5c193a9))
+
+### Changes
+
+* [**Breaking:**](https://github.com/cds-snc/gcds-components/blob/main/CHANGELOG.md#0210-2024-05-08) Component rewrites (form-associated, gcds-radio-group, CSS rewrites)  ([#486](https://github.com/cds-snc/gcds-components/issues/486)) ([ae05841](https://github.com/cds-snc/gcds-components/commit/ae0584172bb2219f907074c48235ae8b4f8719f5))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * peerDependencies
+    * @cdssnc/gcds-components bumped from ^0.20.0 to ^0.21.0
+
 ## [0.20.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-angular-v0.19.1...gcds-components-angular-v0.20.0) (2024-03-14)
 
 

diff --git a/packages/angular/package-lock.json b/packages/angular/package-lock.json
diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cdssnc/gcds-components-angular",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "author": "Government of Canada / Gouvernement du Canada",
   "description": "Angular wrapper for gcds-components",
   "homepage": "https://design-system.alpha.canada.ca/",
@@ -20,7 +20,7 @@
   "peerDependencies": {
     "@angular/common": "^16.0.0",
     "@angular/core": "^16.0.0",
-    "@cdssnc/gcds-components": "^0.20.0"
+    "@cdssnc/gcds-components": "^0.21.0"
   },
   "dependencies": {
     "tslib": "^2.3.0"

diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.21.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-react-v0.20.0...gcds-components-react-v0.21.0) (2024-05-08)
+
+
+### New Features
+
+* add tag prop to gcds-sr-only component ([#484](https://github.com/cds-snc/gcds-components/issues/484)) ([dfb7285](https://github.com/cds-snc/gcds-components/commit/dfb7285a14b477f4c4f71750e8b09d3ca5c193a9))
+
+### Changes
+
+* [**Breaking:**](https://github.com/cds-snc/gcds-components/blob/main/CHANGELOG.md#0210-2024-05-08) Component rewrites (form-associated, gcds-radio-group, CSS rewrites)  ([#486](https://github.com/cds-snc/gcds-components/issues/486)) ([ae05841](https://github.com/cds-snc/gcds-components/commit/ae0584172bb2219f907074c48235ae8b4f8719f5))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @cdssnc/gcds-components bumped from ^0.20.0 to ^0.21.0
+
 ## [0.20.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-react-v0.19.1...gcds-components-react-v0.20.0) (2024-03-14)
 
 

diff --git a/packages/react/package-lock.json b/packages/react/package-lock.json
diff --git a/packages/react/package.json b/packages/react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cdssnc/gcds-components-react",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "author": "Government of Canada / Gouvernement du Canada",
   "description": "React wrapper for gcds-components",
   "homepage": "https://design-system.alpha.canada.ca/",
@@ -29,7 +29,7 @@
     "gcds.css"
   ],
   "dependencies": {
-    "@cdssnc/gcds-components": "^0.20.0"
+    "@cdssnc/gcds-components": "^0.21.0"
   },
   "devDependencies": {
     "@types/react": "^18.2.48",

diff --git a/packages/web/CHANGELOG.md b/packages/web/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.21.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-v0.20.0...gcds-components-v0.21.0) (2024-05-08)
+
+
+### New Features
+
+* add tag prop to gcds-sr-only component ([#484](https://github.com/cds-snc/gcds-components/issues/484)) ([dfb7285](https://github.com/cds-snc/gcds-components/commit/dfb7285a14b477f4c4f71750e8b09d3ca5c193a9))
+
+### Changes
+
+* [**Breaking:**](https://github.com/cds-snc/gcds-components/blob/main/CHANGELOG.md#0210-2024-05-08) Component rewrites (form-associated, gcds-radio-group, CSS rewrites)  ([#486](https://github.com/cds-snc/gcds-components/issues/486)) ([ae05841](https://github.com/cds-snc/gcds-components/commit/ae0584172bb2219f907074c48235ae8b4f8719f5))
+
+
+### Bug Fixes
+
+* Update utility functions for more usability ([#495](https://github.com/cds-snc/gcds-components/issues/495)) ([a0e8fbb](https://github.com/cds-snc/gcds-components/commit/a0e8fbbf5ed8004f72f4e51ca2f2da4ef70a37ef))
+
 ## [0.20.0](https://github.com/cds-snc/gcds-components/compare/gcds-components-v0.19.1...gcds-components-v0.20.0) (2024-03-14)
 
 

diff --git a/packages/web/package-lock.json b/packages/web/package-lock.json
diff --git a/packages/web/package.json b/packages/web/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cdssnc/gcds-components",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "author": "Government of Canada / Gouvernement du Canada",
   "description": "Web components for the GCDS",
   "homepage": "https://design-system.alpha.canada.ca/",