Releases: nasa-jpl/explorer-1
Version 1.0.0
Changes
β¨ Features
- Add browserslist, update postcss-preset-env, and remove dependencies we don't need to install on their own (#111)
π Bug Fixes
- Storybook: fix gallery function in carousel lightboxes (#118)
- BaseCarouselCards: consistent display breakpoints for navigation arrows (#133)
π Documentation
- Update README and Getting Started guide (#98)
- Storybook: reorganize docs and add more guides (#137)
- Storybook: clean up component organization and add a table of contents for each section (#133)
- Storybook: change
storyDecorator
tostoryRoot
(#113)
π§° Maintenance
-
Bumping dependencies and removing unused ones
- Bump Swiper from 6.6.2 to 8.0.2 and migrating templates from v6 to v8 (#71, #131, #136)
- Bump @fancyapps/ui from 4.0.5 to 4.0.23 (#105, #124, #135)
- Bump @storybook/html from 6.4.17 to 6.4.18 (#134)
- Bump postcss from 8.3.6 to 8.4.6 (#93, #132)
- Bump eslint from 7.32.0 to 8.8.0 (#115, #128)
- Bump postcss-preset-env from 6.7.0 to 7.3.0 (#66, #126)
- Bump storybook dependencies from 6.4.14 to 6.4.17 (#88, #120, #125)
- Bump eslint-plugin-storybook from 0.5.5 to 0.5.6 (#116)
- Bump parcel from 2.1.1 to 2.2.1 (#109)
- Bump lazysizes from 5.3.0 to 5.3.2 (#97)
- Bump prettier from 2.4.1 to 2.5.1 (#87)
- Bump stylelint-config-prettier from 8.0.2 to 9.0.3 (#89)
- Bump JamesIves/github-pages-deploy-action from 4.1.5 to v4.x (currently 4.2.2) (#80)
- Bump browser-sync from 2.26.14 to 2.27.7 (#65, #112)
- Bump parcel, @parcel/transformer-sass, parcel-namer-rewrite (#84)
- Remove babel-loader as independent dependency (#108)
- Remove unused postcss-loader (#96)
- Remove postcss-cli (#92)
- Release Drafter: Add 'dependencies' label to the Maintenance category (#91)
Migration guide: 1.0.0-beta.3 to 1.0.0
- Change all instances of CSS class name
.swiper-container
to.swiper
. Also check templates for usage of this class. - A change has been made to the
BaseCarouselCards
template, which affectsBlockArticleCarousel
andBlockFactCards
templates as well. The navigation div,<div class="swiper-navigation lg:block">
, should changelg:block
toxl:block
. This ensures the navigation arrows only appear when the space between each card is 56px (i.e. the 1280px breakpoint).
For a la carte users
A few more migration steps are necessary for projects that are bundling their own frontend assets.
- Syntax for importing the Swiper js library has changed. If you were importing the library from
swiper/core
and using theSwiperCore
class, you will need to update your implementation to importSwiper
fromswiper
. Refer to Explorer 1's implementation as an example. - Optional: modules can now be passed with SwiperOptions. Instead of
Swiper.use([Navigation, Lazy, A11y])
, you can pass them asmodules: [Navigation, Lazy, A11y]
- The
/src/js/
folder has been reorganized. If you are importing JavaScript files from/src/js/
, you will need to update your paths:Old path New path src/js/_lazysizes
src/js/vendors/_lazysizes
src/js/_swiper
src/js/vendors/_swiper
src/js/_swiperOptions
src/js/vendors/_swiperOptions
src/js/_HeroMedia
src/js/components/_HeroMedia
Full Changelog: 1.0.0-beta.3...1.0.0
Version 1.0.0-beta.3
Notable Changes
Breaking Changes
Fixing a sass deprecation warning in #62 has led to some breaking changes for projects that use scss assets a la carte. Your project now needs to use a sass compiler that supports usage of @use
directives, and also use a version of sass that includes the sass:math
module.
Projects using Parcel as their frontend bundler with node-sass
as their sass compiler will likely encounter the following build error:
π¨ Build failed.
@parcel/transformer-sass: Undefined function.
β·
11 β padding-bottom: math.div($height, $width) * 100%;
To fix, remove node-sass
to default to Parcel's built-in dart-sass
. If that still doesn't work, you may need to install [email protected]
to override the version of sass bundled with Parcel.
Projects using sass-loader
- remove
node-sass
and installsass
Style changes:
.BlockTable
- This CSS class has been extended to include styles for various types of content within in a table, spefically for use with Wagtail's TypedTableBlock. Check your usage ofBlockTable
for any unexpected visual changes- Pagination in
.BlockImageCarousel
and.BlockImageGallery
has additional styles applied. If your project has configured swiper with different pagination rules, then these styles may conflict. Be sure to check the mobile pagination of these blocks when updating. - Additional focus styles have been applied to
BaseButton
- WCP:
HeroMedia
styles are now part of Explorer-1, specifically styles for the show/hide caption on mobile. These styles can now be removed from WCP and imported from Explorer-1.
Script changes:
- WCP: JavaScript for
HeroMedia
is now provided by Explorer-1._HeroMedia.js
can be removed and imported from Explorer-1. instead.
Summary of Changes
Features
- Extend BlockTable styles to support new content types by @Scotchester in #79
Maintenance and Docs
- Storybook: Add
BlockRelatedLinks
component by @laespinoza in #45 - Storybook: Add
BlockTeaser
component by @laespinoza in #47 - Storybook: Add
BlockTable
component by @laespinoza in #46 - Storybook: Add
BlockVideoEmbed
component by @laespinoza in #48 - Storybook: Add
HeroFeature
component by @laespinoza in #49 - Storybook: Add
HeroFocalPoint
component by @laespinoza in #50 - Storybook: adding descriptions to BaseLink and HeroFocalPoint by @stephiescastle in #51
- Storybook: Add
RoboticsDetailFactsItem
component by @laespinoza in #53 - Storybook: Add
HeroMedia
component by @laespinoza in #52 - Storybook: Add
SearchResultCard
component by @laespinoza in #54 - Storybook: Add
BlockImageCarousel
component by @laespinoza in #56 - Storybook: Add
BlockImageGallery
component by @laespinoza in #57 - Storybook: adding all icon stories by @stephiescastle in #63
- Storybook: update storybook version, add storybook linter, fix deprecation warnings by @stephiescastle in #62
- Storybook: Add
BaseCarouselCards
,ArticleCarousel
, andRoboticsDetailFacts
components by @stephiescastle in #70 - Adding dependabot config by @stephiescastle in #61
Full Changelog: 1.0.0-beta.2...1.0.0-beta.3
Version 1.0.0-beta.2
Changes
β¨ Features
- Adds semantic colors and base styles for form elements (#43)
- Adds @fancyapps/ui for modals and lightboxes (#38)
π Documentation
- Storybook: Add
BlockQuote
component (#44) - Storybook: Add
BlockImage
component (#38) - Storybook: Add
BlockInlineImage
component (#35) - Storybook: Add
BlockImage
component (as well as Fancybox) (#38) - Storybook: Add
BlockKeyPoints
component (#39) - Storybook: Add
BlockText
component (#31) - Storybook: Add
BlockIframeEmbed
component (#29) - Storybook: Add
BasePlaceholder
component (#26) - Storybook: Add
BaseImageCaption
component (#25) - Storybook: Add
ArticleCarouselItem
component (#22)
π§° Maintenance
- Re-ordering Tailwind imports and adding ignore files for linters (#36)
- Set up linters and GitHub Actions workflow to run them on PRs (#30)
- Set up Release Drafter workflow in GitHub Actions (#24)
Migration guide
- Input fields will now default to having a
gray-light-mid
border. For input fields that should not have a border, add classborder-0
to them. - Projects applying a border-color to their inputs should remove those styles in order to inherit those from Explorer-1.
- Projects importing SCSS partials a la carte will need to import the new
_forms.scss
partial as one of the first imports in the main SCSS file. - Projects that have defined their own semantic colors should remove those color definitions from their TailwindCSS config and use those provided by Explorer-1 instead.
Version 1.0.0-beta.1 β Initial public release
This marks the first public release of the Explorer 1 Design System! π
For users of the internal alpha releases, please note that this release contains breaking changes with regard to support for Internet Explorer:
The following resources were deleted and need to be removed from your project's JS and SCSS imports:
src/js/_detect-ie.js
, including the node polyfill forglobal
src/scss/components/_RoboticsDetailFacts.scss
src/scss/components/_SearchResultCard.scss
- all
.woff
files- This has been accounted for in explorer-1's styles, but be aware of this in case you are importing
.woff
files a la carte.
- This has been accounted for in explorer-1's styles, but be aware of this in case you are importing