From 5d5446da4465d1804dd91c08ba12205720200b8f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 5 Apr 2021 17:58:41 +0000 Subject: [PATCH] Version Packages --- .changeset/clever-dancers-nail.md | 39 ------------------------------ CHANGELOG.md | 40 +++++++++++++++++++++++++++++++ package.json | 2 +- 3 files changed, 41 insertions(+), 40 deletions(-) delete mode 100644 .changeset/clever-dancers-nail.md diff --git a/.changeset/clever-dancers-nail.md b/.changeset/clever-dancers-nail.md deleted file mode 100644 index 95387647a0e..00000000000 --- a/.changeset/clever-dancers-nail.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -"@primer/components": major ---- - -Type definitions are now being generated by TypeScript instead of manually maintained. These new type definitions may differ from the previous type definitions and cause breaking changes. If you experience any new TypeScript errors, feel free to create an [issue](https://github.com/primer/components/issues) or reach out in Slack (#design-systems). - -### Breaking changes - -* The following types are no longer exported: - - ``` - BaseProps - UseDetailsProps - AnchoredPositionHookSettings - AnchorAlignment - AnchorSide - PositionSettings - PaginationHrefBuilder - PaginationPageChangeCallback - PositionComponentProps - ``` - -* Props are now defined with types instead of interfaces which means in some cases you may not be able to create interfaces that `extend` them. To work around this issue, you may need to convert your interfaces to types: - - ```diff - import {BoxProps} from '@primer/components' - - - interface MyFancyBox extends BoxProps {...} - + type MyFancyBox = BoxProps & {...} - ``` - -* Some components now expect more specific ref types. For example: - - ```diff - - const ref = React.useRef(null) - + const ref = React.useRef(null) - - return - ``` diff --git a/CHANGELOG.md b/CHANGELOG.md index 7943e15bbfb..1d003121af2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,45 @@ # @primer/components +## 27.0.0 + +### Major Changes + +- [`db478205`](https://github.com/primer/components/commit/db478205bf467a118394e0519034bb87116dc85a) [#1147](https://github.com/primer/components/pull/1147) Thanks [@colebemis](https://github.com/colebemis)! - Type definitions are now being generated by TypeScript instead of manually maintained. These new type definitions may differ from the previous type definitions and cause breaking changes. If you experience any new TypeScript errors, feel free to create an [issue](https://github.com/primer/components/issues) or reach out in Slack (#design-systems). + + ### Breaking changes + + - The following types are no longer exported: + + ``` + BaseProps + UseDetailsProps + AnchoredPositionHookSettings + AnchorAlignment + AnchorSide + PositionSettings + PaginationHrefBuilder + PaginationPageChangeCallback + PositionComponentProps + ``` + + - Props are now defined with types instead of interfaces which means in some cases you may not be able to create interfaces that `extend` them. To work around this issue, you may need to convert your interfaces to types: + + ```diff + import {BoxProps} from '@primer/components' + + - interface MyFancyBox extends BoxProps {...} + + type MyFancyBox = BoxProps & {...} + ``` + + - Some components now expect more specific ref types. For example: + + ```diff + - const ref = React.useRef(null) + + const ref = React.useRef(null) + + return + ``` + ## 26.0.0 ### Major Changes diff --git a/package.json b/package.json index e9105f12a28..039c4c060b7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@primer/components", - "version": "26.0.0", + "version": "27.0.0", "description": "Primer react components", "main": "lib/index.js", "module": "lib-esm/index.js",