Skip to content

Latest commit

 

History

History
475 lines (318 loc) · 29.1 KB

CHANGELOG.md

File metadata and controls

475 lines (318 loc) · 29.1 KB
Raw

9.2.0

Improvements

  • Update styling for Alert component for increased contrast and consistency with U.S. Web Design System. (#439)
  • Update styling for Validation component icons for consistency with U.S. Web Design System. (#441)
  • Update markup for badge component to use U.S. Web Design System icons. (#442)
    • Existing usage will not be affected until the next major release (see "Deprecations").

Deprecations

  • Badge component markup has been updated and will be required in the next major release. (#442)
  • Custom alert icons will be removed in the next major release, use U.S. Web Design System alerts instead.
    • alerts/error.svg
    • alerts/info.svg
    • alerts/success.svg
    • alerts/unphishable.svg
    • alerts/warning.svg

9.1.0

New Features

  • Add SVG format option for favicon image. (#424)
  • Add "centered" variant for banner component. (#429)

Improvements

  • Update styling for Tag component for consistency with U.S. Web Design System. (#426)
  • Hide collapsed Accordion component content while JavaScript loads. (#434)

Dependencies

9.0.0

Breaking Changes

  • Prose styling overrides have been removed. Text formatting should now adhere to the defaults from the U.S. Web Design System. (#390)
  • Drop support for Internet Explorer. (#387)
    • Support was indirectly dropped in v7.0.0 via the upgrade to USWDS v3.0.0, which similarly ended explicit support for Internet Explorer. This package had continued to include Internet Explorer in its Browserslist configuration, but this has now been removed.
  • Remove utility classes for raw color tokens. (#405)
    • These colors were usually incorrect because they were using U.S. Web Design System defaults instead of the Login.gov Design System color set.
    • In most common cases, these should be replaced with stateful equivalents ("success" instead of "green") or theme colors ("base" instead of "gray-50").
    • Applies to the following utilities:
      • Background color (bg-*)
      • Border color (border-*)
      • Text color (text-*)
      • Outline color (outline-*)
      • Text underline color (underline-*)
    • The following colors are removed:
      • red (use error instead)
      • orange
      • gold
      • yellow (use warning instead)
      • green (use success instead)
      • mint
      • cyan
      • blue (use primary instead)
      • indigo
      • violet
      • magenta
      • gray-10 (use base-lighter instead)
      • gray-30 (use base-light instead)
      • gray-50 (use base instead)
      • gray-70 (use base-darker instead)
      • gray-90 (use base-darkest instead)
  • Remove images not integral to the design system. (#410)
    • If you use any of these images, consider proposed alternatives below, or copy the image from the previous release into your project:
      • illustrations/fail.svg (legacy alert icon, new alert icons will be introduced in a future release)
      • illustrations/security-key.svg
      • angle-arrow-down-white-hover.svg (use expand_more icon instead)
      • angle-arrow-down-white.svg (use expand_more icon instead)
      • angle-arrow-down.svg (use expand_more icon instead)
      • angle-arrow-up-white-hover.svg (use expand_less icon instead)
      • angle-arrow-up-white.svg (use expand_less icon instead)
      • angle-arrow-up.svg (use expand_less icon instead)
      • close-primary.svg (use close icon instead)
      • close.svg (use close icon instead)
      • hero.png
  • Align JavaScript component names with U.S. Web Design System. (#414)
    • header is now named navigation
    • validation is now named validator

Improvements

  • Optimize images to reduce their size. (#411)
  • Browser-ready JavaScript bundles are now minified. (#421)

New Features

  • Add TypeScript types for JavaScript components. (#413)
  • Include init.js as both a package entrypoint and precompiled asset within dist/assets/js, which provides the functionality of U.S. Web Design System's uswds-init.js script to reduce the appearance of flashing content during page load. See README Browser-Ready JavaScript Bundles for usage instructions. (#421)

Bug Fixes

  • Add missing JavaScript exports for button, inPageNavigation, inputMask, languageSelector, and range. (#407)
  • Fix dist/assets/js/main.js compilation to properly consider browser support. (#421)
  • Fix strict ES Module import errors due to lack of fully-qualified file path when importing auto entrypoint. (#422)
  • Fix background color when hovering an expanded navigation section on large viewport sizes. (#418)

Internal

  • Replace code compiler Babel with ESBuild. (#387)
    • This is not expected to have a downstream impact, but there may be subtle differences in the compiled code due to this change.

8.1.2

Bug Fixes

  • Fix issue with dual export backwards-compatibility resulting in errors loading in CommonJS projects. (#401)

8.1.1

Bug Fixes

  • Fix strict ES Module import errors due to lack of fully-qualified file path. (#400)

8.1.0

New Features

  • Add variant support for danger outline buttons. (#383)

Bug Fixes

  • Improve consistency with USWDS disabled buttons styles. (#383)
    • USWDS v3.5.0 removed .usa-button--disabled styling in favor of [aria-disabled="true"]. This wasn't documented as a breaking change, and it's expected the any .usa-button--disabled usage would not be stylized correctly since those changes. You should replace any usage of usa-button--disabled with either the [disabled] or [aria-disabled="true"] attributes.

Dependencies

Internal

  • The package is now distributed using native ES Modules as the default output. This should not impact downstream CommonJS projects, as a CommonJS distributable is still included for now. (#395)

8.0.1

Bug Fixes

  • Fix an issue where accordion icons appear smaller when hovering the expander button. (#379)

8.0.0

Breaking Changes

7.1.0

New Features

  • Add custom styling for the Icon List component. (#368)
  • Add new Image Example component. (#369)

Improvements

  • Fix appearance of borders in segmented "Big" button groups. (#359)
  • Improve compilation time for default package by upwards of 50%. (#356)

Bug Fixes

  • Fix issue where the Process List "Big" variant would show with the connected line when not rendered in prose content. (#357)
  • Add meta charset to documentation layout to fix visual regressions tests (#361)

7.0.1

Bug Fixes

  • Fix header navigation current link styling regression in 7.0.0 release. (#352)
  • Fix dark background sections to show heading text as white. (#352)
  • Fix issue causing search button widths to collapse when displayed in narrow containers. (#354)

Breaking Changes for Undocumented APIs

Note: While these are backwards-incompatible changes, the major version is not being changed because they impact features which were never part of a publicly-documented API.

  • Remove .usa-sidenav--sticky CSS class. (#352)

7.0.0

Breaking Changes

  • NPM package renamed from identity-style-guide to @18f/identity-design-system. (#331)
  • Update USWDS from 2.13.3 to 3.4.1. (#321)
    • Polyfills have been removed, consistent with current Login.gov browser support
    • The following JavaScript named exports have been renamed or removed:
      • navigation is renamed to header
      • validator is renamed to validation
    • Refer to README.md for updated usage instructions, as well as the U.S. Web Design System migration guide.
  • Sass artifacts now require Dart Sass. The Ruby Sass and LibSass (C) compilers are no longer supported. (#298)
  • To improve performance of the default CSS bundle, responsive utility breakpoints other than tablet: have been disabled by default. Previously, mobile-lg: and desktop: utilities were also enabled. You can restore the original settings by overriding the $theme-utility-breakpoints Sass variable. (#298)
    • Component styling which previously responded to now-disabled breakpoints have been updated to standardize on the tablet breakpoint. This affects usa-button--wide, usa-search--big, and usa-intro CSS classes.
  • Image URLs in stylesheets are no longer processed by asset-path-if-exists. For Rails integrations, consider using the $theme-image-path Sass variable in combination with Sprockets resolve_assets_in_css_urls option. (#298)
  • The deprecated $image-path Sass variable setting has been removed. Use $theme-image-path instead. (#298)
  • The deprecated alerts/success-badge.svg image has been removed. Use alerts/success.svg instead. (#298)
  • The deprecated .usa-form-hint CSS class has been removed. Use .usa-hint instead. (#337)
  • Removed usa-alert__paragraph alert helper class. Use measure-3 measure utility instead. (#298)
  • The Spinner component has been removed (.lg-spinner). A new "Loading" component will be made available in a future release. (#347)
  • The all-white Login.gov logo login-gov-logo-rev.svg has been replaced with a new color-reversed version src/img/login-gov-logo-reverse.svg. (#351)

New Features

  • Add Tag component styles. (#346)

6.7.0

Improvements

  • Add new "Big" variant of Dropdown component. (#328)

6.6.0

Improvements

  • Add new "Big" variants of Text Input and Textarea components. (#326)
  • Update Text Input styling to adhere to design specification. (#325)

6.5.0

Improvements

  • Increase line-height for accordion heading content to improve readability. (#316)

6.4.2

Dependencies

  • Update USWDS from v2.13.2 to 2.13.3. (#312)

Improvements

  • Add styles and markdown content for selected and disabled radios and checkboxes. (#313)

6.4.1

Bug Fixes

  • Fix an issue where search field submit buttons would not show text at small viewport sizes. (#311)

6.4.0

Deprecation Notice

  • The alerts/success-badge.svg image will be removed in a future major version. Use alerts/success.svg instead. (#306)

Improvements

  • Improve appearance of illustrated tile checkboxes and radio buttons. (#309)

Bug Fixes

  • Use correct "Success" green color for alerts/unphishable.svg icon. (#306)

Optimization

  • Remove documentation-specific images from published package. (#300)
  • Remove duplicate styles. (#301)
  • Reconcile redundant focus styles with U.S. Web Design System. (#302)
  • Remove documentation site styles from design system artifact. (#305)
  • Reduce size of SVG images. (#307)

Dependencies

  • Update USWDS from v2.13.1 to 2.13.2. (#304)
  • Update dependencies to resolve vulnerability advisories. (#308)

6.3.3

Bug Fixes

  • Changing the radio tile image size from 1rem to 1.5rem. (#299)

6.3.2

Improvements

  • Line height calculations are improved such that the desired token size will always apply regardless of font family or scale. (#291)
    • In the case of headings, line-height will fall back to the configured body line-height if the resulting actual line-height would be smaller than body content when using the heading scale.
  • Body font size has been increased slightly to restore an effective font size of 1rem. (#292)
  • The Process List component no longer applies vertical padding which would affect its layout relative to surrounding content. (#290)
  • Input hint text is no longer italicized. (#293)
  • New variation of checkbox and radio button tiles with illustrations is added to form fields. (#296)

6.3.1

Bug Fixes

  • Improve vertical spacing in heading of Process List item spanning multiple lines. (#288)
  • Fix external link icon margin when followed by additional text content. (#289)

6.3.0

New Features

  • Field validation success is added to form validation. (#265)
  • Added custom styling for the Process List component. (#279)

Improvements

  • The default font is now Public Sans for both headings and body copy. This is not being considered a breaking change, as it is the new default guidance. To preserve existing font settings to allow more time to migrate, set $theme-font-type-sans: 'source-sans-pro'; and $theme-font-type-serif: 'merriweather';. (#264)
  • Add Login.gov-specific component configuration. (#258)
  • The default line-height is now set to 1.5. This is not being considered a breaking change, as it is the new default guidance. To preserve existing font settings to allow more time to migrate, set $theme-body-line-height: 6. (#283)
  • Overlay is now shown with a lighter backdrop color. (#260)
  • Form Dropdown is now more visually consistent with other form fields. (#263)
  • Form hint text is now shown with an italicized style and increased vertical margins. (#262)
  • Icons for form validation errors are aligned to the top. (#265)
  • The tile variant of checkboxes and radio buttons have a slightly increased font size. (#281)
  • Checkbox and radio labels which span multiple lines should now appear with a consistent line height relative to surrounding body copy. (#283)
  • Search will now show full text labels at all sizes, and uses standardized font tokens. (#259)

Bug Fixes

  • Fix an issue where .usa-input--error would apply the incorrect border color unless also accompanied by .usa-input, .usa-textarea, or .usa-select. (#275)

Dependencies

6.2.0

New Features

  • All theme variables are now set as default values, allowing you to override them for per-project requirements. (#247)
    • Note: Since the design system is meant to be an opinionated set of smart defaults, it's recommended to use restraint with variable customization, or at least consider when it may be more appropriate to adjust a setting from the design system itself in order to maintain consistency across projects.
  • Responsive variants of width utility classes are now enabled. (#248)

Improvements

  • Navbar link text is no longer uppercase. (#249)
  • Visual alignment of Badge component is improved, and its markup guidance has been simplified with improved accessibility semantics. (#251)
  • Field validation error messages now use updated styling to always display an icon as part of the error message, and not within the field itself. The modifier classes usa-input--inline and usa-error-message--with-icon no longer have any effect and can be safely removed. (#255)
  • Focus styles for links and unstyled buttons are now the same. (#253)

6.1.0

Improvements

  • USWDS is upgraded to the latest version, from v2.11.2 to v2.12.1.
  • Whitespace in checkbox and radio label markup will no longer cause the label text to be misplaced.
  • Margins surrounding an external link icon have been increased slightly.
  • Padding and label font size for tile checkboxes and radio buttons have increased slightly.

6.0.0

Breaking Changes

  • USWDS is upgraded to the latest version, from v2.9.0 to v2.11.2.
    • The bordered and large styles of checkboxes and radio buttons have updated guidance to improve compatibility with the USWDS tile style. The classes usa-radio-bordered, usa-radio-large, usa-checkbox-bordered, and usa-checkbox-large have been removed. Instead, add usa-radio__input--bordered, usa-radio__input--tile, usa-checkbox__input--bordered, usa-checkbox__input--tile respectively as modifiers to the element with the class usa-radio__input or usa-checkbox__input.
  • The Accordion component no longer includes a "Close" button. Remove any instances of <button class="usa-accordion__close-button"> in your project, or references to the accordionCloseButton exported member of the JavaScript package.

5.1.0

New Features

  • Add support for SASS package entrypoints to limit or control loading of styles, similar to USWDS components. Available packages are packages/required, packages/global, packages/components, and packages/utilities.
  • The Side Navigation component is now documented and includes updated and improved styling. While this should not require any markup changes, you should validate that the updated styling does not conflict with any product-specific styles for side navigation.

Bug Fixes

  • Reduce the border width of the normal outline button to the intended width of 1px (previously 2px). The big variant of the outline button is unaffected by this change, and remains 2px.
  • Fix rounded corners on sidebar current page item.
  • Fix unintentional rounded corners on search text field.
  • Fix utility classes not always applying as expected when applied to components. For example, using margin- utility classes on an unstyled button would previously unexpectedly conflict with and not take precedent over the button's own margins.
  • Fix all instances of font weight appearance of unstyled buttons in content which applies anti-aliased font smoothing. Previous bug fix attempts had still missed default :hover and :active states.

5.0.3

Bug Fixes

  • Fix font weight appearance of unstyled buttons in content which applies anti-aliased font smoothing.

5.0.2

Bug Fixes

  • Fix the appearance of unstyled buttons to appear visually identical to a link.

5.0.1

Bug Fixes

  • Fix an issue where a second focus ring effect was still applied to the unstyled button variant.

5.0.0

Breaking Changes

  • Several button variants have been removed. These include:
    • Success (usa-button--success)
    • Dropdown (usa-button--dropdown)
    • Small (usa-button--small)
    • Tiny (usa-button--tiny)
  • The Password Strength Meter component has been removed.

Improvements

  • Link hover and active colors are now distinct.
    • Before: Hover and active colors are both primary-darker.
    • After: Hover is primary-dark, and active is primary-darker.
  • Improved support for "Unstyled" button variant
  • Add three new button variants to control width:
    • usa-button--wide displays a button at a wider (minimum) width at larger viewport displays.
    • usa-button--flexible-width displays a button at flexible width regardless of viewport size, and overrides default mobile appearance of full-width buttons.
    • usa-button--full-width displays a button at full width regardless of viewport size, and overrides default desktop appearance of flexible-width buttons.

Bug Fixes

  • Fix an issue where focused buttons appear with a double focus ring style.
  • Fix an issue where using the "auto" package entrypoint may cause components not to be loaded when used with some bundlers (e.g. Webpack).

Documentation

  • Add documentation for "Big" button variants.
  • Rename "Secondary" as "Outline" in buttons documentation.

4.0.0

Breaking Changes

  • The Spinner button has been removed (.usa-button__lg-invokeSpinner).
  • Favicon images have been updated for consistency with the U.S. Web Design System. Existing references to favicon-16x16.png should be updated to favicon-16.png. favicon-32x32.png has been removed. The closest substitute is favicon-40.png, at size 40 pixels x 40 pixels.

Improvements

  • New favicon size variations are available. The complete set of pixel sizes are: 16, 40, 57, 72, 114, 144, 192.

Bug Fixes

  • Fix an issue where builds may produce styles in an unpredictable order.
  • Fix an issue where .usa-display heading font size was rendered larger than intended.
  • Fix an issue where dropdownButton was using invalid CommonJS syntax when imported from ES module entrypoint.
  • Fix an issue where .usa-prose heading margins were not applied consistently.
  • Fix an issue where importing subpaths may not resolve correctly using native ES modules.

Internal

  • Replace deprecated USWDS variable references with updated equivalent values.

3.0.0

Breaking Changes

  • Updates USWDS from 2.0.3 to 2.9.0. Review release notes for specific changes which may apply. Specific impactful changes include...
    • The Tooltip component is now inherited from USWDS, newly introduced as of USWDS 2.8.0. See component documentation for more information. The markup of this component is significantly different than that of the component previously implemented in the Login.gov Design System.
    • Due to a rounding precision fix, line-heights for text may appear larger than it had previously.
    • Guidance for many components has been updated to improve accessibility and usability of markup. Neglecting to update this markup should not result in user-facing regressions, but you are recommended to update to improve end-user experience. Refer to the release notes and related component documentation for specifics:
      • SVG images should include role="img".
      • Numeric fields should use type="text" inputmode="numeric" instead of type="number".
      • Search forms should assign role="search" to the form element.
      • Banner should be rendered as a section element instead of a div, and include a descriptive aria-label.
      • Footer and hero content should include a descriptive aria-label.
      • Graphic list should use h2 as a heading element instead of h3.
  • "Official government website" banner text has been updated. Refer to USWDS guidance for updated markup.

New Features

  • The published NPM package can now be imported into a project. Bundlers that support dead-code elimination (Webpack, etc.) can automatically remove unused code to optimize bundle size. Existing usage of JavaScript code from dist/assets/ is unaffected by these changes.

Bug Fixes

  • Fixed support for multiple dropdown buttons on a page.