-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Release v13.0.0 #1723
Release v13.0.0 #1723
Conversation
* feat(timelinenav)!: remove top-level sub-component * refactor(timelinenav): remove useless undefined typing
- merge BreadcrumbsItem into Breadcrumbs directly
* refactor(toolbar)!: remove component * refactor(toolbar)!: remove the subcomponents too * fix: remove some padding
* feat(table)!: remove top-level sub-components * refactor(table): rename props type decl
* feat(searchbar)!: remove top level subcomponents * fix(searchbar): add missing styles
- in newly composed component also use code block for prop documentation
* feat(radio)!: remove top level subcomponents * refactor(radio): use size tokens
- Combine card sub components into one file - update docs to reflect this new paradigm - rename directory and adjust copy
- point users of the components to use tailwind CSS instead
* refactor(inputfield): use inputlabel and re-export as subcomp * docs(inputfield): add comment spacing
* refactor(textareafield): use inputlabel and re-export as subcomp * feat(textareafield)!: remove top level subcomponent
- also mark as deprecated, linking to TW documentation
feat!: Merge and remove top-level components
- Link to relevant HeadlessUI documentation - Add recommendations for how to use with inline examples - Typo and other documentation improvements
Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>
- remove all legacy colors - remove legacy typography tokens and mixins - replace usages in demos with newe type tokens - recompile all exported assets
- remove Grid and Layout component examples - add deprecation warning - provide useful links to tailwind documentation - mark associated layout tokens as deprecated
refactor: remove deprecated dropdown
…token (#1711) * refactor(colors)!: remove deprecated and legacy colors * docs(colors): convert to input colors and show figma token
- this removes recipes that are product-specific - this is prep work to sync up with updated (stricter) recipe guidelines in the doc.s
- move individual implementation examples under related components, then label them as such - update snapshots - remove plop integrations for creating new recipes and pages - remove lingering recipes that were used in pages
* chore(deps): update prettier * refactor: apply lint and snapshot fixes --------- Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com> Co-authored-by: Andrew Holloway <booc0mtaco@users.noreply.github.com>
- clean up any remaining references to recipes and pages in our documentation - add link to refer back to zeroheight if someone comes looking here for information
* docs: split t2 colors stories and remove t2 stories aggregator * docs: split t3 colors stories and remove t3 stories aggregator * docs: fix tailwind classes in color tokens stories * docs: recurse filters tokens to primary value * test: skip t3 button chromatic * docs(tokens): style colors into a table
Co-authored-by: Renovate Bot <renovate@whitesourcesoftware.com>
* refactor(link): add background t3 tokens * refactor(link): point t3 tokens to t2 temp * refactor(link)!: point t3 to t1 tokens * refactor!: remove deprecated tokens * fix(tabs): use correct color token * refactor(link): re-remove text-link tokens re-added in rebase * fix(tokens): point tier 3 tokens to relevant tier 2 token values --------- Co-authored-by: Jin Lee <jin.lee@chanzuckerberg.com> Co-authored-by: Andrew Holloway <booc0mtaco@users.noreply.github.com>
As a part of this release, we will annotate the release notes with guidance on how to address any breaking changes. This could be as a set of summary blocks added to the release notes, OR as a link to the EDS repo Wiki detailing migration steps from 12 to 13. |
Codecov Report
@@ Coverage Diff @@
## main #1723 +/- ##
==========================================
- Coverage 93.17% 92.27% -0.91%
==========================================
Files 222 146 -76
Lines 2975 2575 -400
Branches 725 664 -61
==========================================
- Hits 2772 2376 -396
- Misses 187 198 +11
+ Partials 16 1 -15
... and 12 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
size-limit report 📦
|
Is there anything specific to look over in this PR or since it's a collection of previously merged PRs not really? |
@jeremiah-clothier I'm adding in instructions to the summary above, explaining how to resolve any of the breaking changes. Once i finish that, if you could have a look and see if those read pretty clearly, that would be most helpful :D For release PRs, the main thing is to verify the change log is correct and helpful |
okay @booc0mtaco feel free to ping me when all the instructions are added |
@jeremiah-clothier all done. Let me know if any adjustments seem useful. I think I captured all the relevant details to mention from the individual PRs, and this release has as much of the breaking stuff as we could get together |
13.0.0 (2023-08-14)
Review the text next to each breaking change for suggestions on how to transform your existing code for compatibility with this version.
⚠ BREAKING CHANGES
link: remove text-link tokens for link t3 tokens (#1639)
The following tokens have been removed, and their usages have been replaced:
--eds-theme-color-text-link-brand
--eds-theme-color-text-link-neutral
New tokens were added in 12.x versions, and are proper tier-2 tokens, which supersede these. For reference they are:
--eds-theme-color-text-neutral-*
(includes,neutral
,strong
,default
, anddefault-inverse
)--eds-theme-color-text-brand-default
Check the relevant figma files and ZH documentation on what values should be set for the tokens above
colors: remove old colors and convert to input and show figma token (#1711)
Many color tokens were long-ago deprecated. They are now being removed to simplify the token set and align with the latest foundation and component files.
This includes the following:
--eds-color-highlight-*
--eds-color-info-*
If you spot any of these in design files, consult with the design team about cleanup.
remove deprecated dropdown (#1657)
The
Dropdown
component is now being removed, to be replaced by the more feature-richMenu
andSelect
components.banner: remove component (#1702)
The
Banner
component was not available in design, as it had been removed some time ago. So we remove it in this release. No designs should use this component. Instead, refer to theInlineNotification
orToast
components.remove legacy tokens and typography mixins (#1709)
We remove the remaining
legacy
tokens from EDS, and the legacy Typography@mixins
. Examples include:--legacy-color-*
--legacy-size-*
These were not being used in any internal components, and should not be used in any product-specific recipes. If they were, work with design to find a supported alternative for those tokens.
Along with those removals, we replace all calls to mixins with equivalent
font:
CSS properties. The mixins were NOT exported, but this does enable the use oftypography
tokens in custom recipes if needed.Grid: remove top-level sub-component(s) (#1703)
If you are importing any
Grid
sub-components in your code, you can remove the import-import GridItem from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
dragdrop: remove top level subcomponents (#1697)
If you are importing any
DragDrop
sub-components in your code, you can remove the import-import DragDropContainerHeader from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
Fieldset: remove top-level sub-component(s) (#1695)
If you are importing any
Fieldset
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
HorizontalStepper: remove top-level sub-component(s) (#1696)
If you are importing any
HorizontalStepper
sub-components in your code, you can remove the import-import HorizontalStep from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
Card: remove top-level sub-component(s) (#1692)
If you are importing any
Card
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
checkbox: remove top level subcomponents (#1693)
If you are importing any
Checkbox
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
radio: remove top level subcomponents (#1690)
If you are importing any
Radio
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
DataBar: remove top-level sub-component(s) (#1686)
If you are importing any
DataBar
sub-components in your code, you can remove the import-import DataBarSegment from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
Modal: remove top-level sub-component(s) (#1689)
If you are importing any
Modal
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
searchbar: remove top level subcomponents (#1687)
If you are importing the
SearchButton
orSearchField
in your code, you can remove the import... and replace references to the sub-component with the following:
table: remove top-level sub-components (#1685)
If you are importing any
Table
sub-components in your code, you can remove the import... and replace references to the sub-component with the following:
toolbar:remove component (#1683)
Toolbar
was removed, as it had no corresponding designs, and prescribed a layout that is more likely to be product specific. If there is a strong design and rationale for a new toolbar, it may re-emerge as a standalone component, composed of various EDS sub-components.If using toolbar, consider replacing with equivalent TailwindCSS Layout classes:
Breadcrumbs: remove top-level sub-component (#1680)
If you are importing the
BreadcrumbsItem
in your code, you can remove the import- import BreadcrumbsItem from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
timelinenav: remove top-level sub-component (#1681)
If you are importing the
TimelineNavPanel
in your code, you can remove the import- import TimelineNavPanel from '@chanzuckerberg/eds';
... and replace references to the sub-component with the following:
Features
Bug Fixes
Avatar: support display names using emoji and multi-byte (#1716) (1294022)
update token exports (#1722) (982c55f)
banner: remove component (#1702) (356550c)
colors: remove old colors and convert to input and show figma token (#1711) (c9a5079)
link: remove text-link tokens for link t3 tokens (#1639) (d35cfe4)
remove deprecated dropdown (#1657) (26d1694)
toolbar: remove component (#1683) (bd47899)