Skip to content

Releases: nasa-jpl/explorer-1

Version 1.7.2

28 Dec 18:40

Choose a tag to compare

Changes

🐛 Bug Fixes

  • Fix two minor issues with headings (#327)

Version 1.7.1

10 Nov 20:22

Choose a tag to compare

Changes

✨ Enhancement

  • Adjust H1 sizes to be less of a dramatic jump from H2 (#318)
  • Reduce line-height of .text-stats-xl and .text-stats-lg to bring it back in line with what it was before (#318)

Version 1.7.0

08 Nov 15:43

Choose a tag to compare

Changes

✨ Features

  • Update type hierarchy (#313)

🐛 Bug Fixes

  • fix: adding icon-only flag to image carousel buttons (#303)

Version 1.6.0

12 Aug 00:39

Choose a tag to compare

Changes

✨ Features

  • Adding an Internal Theme (#253)
  • Adding Internal Header and Internal Footer (#277)

📘 Documentation

  • Documentation for using the new internal theme, internal header, and internal footer (#253, #277)

🧰 Maintenance

  • Bump Storybook to v6.5.10 and add workaround for heading anchors (#270, #285)

Migration Notes

Using the internal theme and components

You can find documentation on how to use the internal theme in our Storybook. If you plan to use this theme a la carte, be sure to also include the newly added SCSS partial:

// your main.scss

// Tailwind CSS
@import 'tailwindcss/base';
@import 'tailwindcss/components';
@import 'tailwindcss/utilities';

// Vendors
@import '@nasa-jpl/explorer-1/src/scss/vendors';

// Main elements: Explorer 1 base styles
@import '@nasa-jpl/explorer-1/src/scss/forms';
@import '@nasa-jpl/explorer-1/src/scss/hover';
@import '@nasa-jpl/explorer-1/src/scss/fonts';
@import '@nasa-jpl/explorer-1/src/scss/aspect-ratios';
@import '@nasa-jpl/explorer-1/src/scss/grid';
@import '@nasa-jpl/explorer-1/src/scss/typography';
@import '@nasa-jpl/explorer-1/src/scss/polyfills';
@import '@nasa-jpl/explorer-1/src/scss/animations';

// Themes: include this if you want to use the internal theme colors 
@import '@nasa-jpl/explorer-1/src/scss/themes/internal'; // ⬅️ include new partial here

// Components: include all components
@import '@nasa-jpl/explorer-1/src/scss/components';

Internal header and footer

You can learn how to use the internal header and footer in our new Global Layout section.

Container Padding

By default, .container now has a default padding of 1rem. For the most part, this should not affect your projects, unless you have built in your own paddings, or used any of the named grid lines for MixedBleed layouts. If so, you can easily override this globally in your tailwind config, or, to address specific use-cases, add .px-0 to the .container in question.

To override the container padding globally, add this to your Tailwind config:

// your-project/tailwind.config.js

// import Explorer 1's Tailwind config
const explorer1Config = require('@nasa-jpl/explorer-1/tailwind.config.js')

module.exports = {
  ...explorer1Config,
  theme: {
    ...explorer1Config.theme,
    container: {
      ...explorer1Config.theme.container,
      padding: '0', // ⬅️ override padding here
    },
  },
  purge: ['../**/*.html'], // your project's purge settings
}

Internal navigation class names

Internal WCP developers: the class names for internal navigation templates have changed to match the naming style of Explorer 1.

Version 1.5.0

29 Jun 15:25

Choose a tag to compare

Changes

✨ Features

  • Adding BlockAccordion component (#250)

🐛 Bug Fixes

  • Set tracking-normal explicitly on H4 and H5 styles (#257)

Version 1.4.0

25 May 16:05

Choose a tag to compare

Changes

✨ Features

  • Adding more colors to tailwind.config.js (#236)

Version 1.3.0

17 May 20:05

Choose a tag to compare

Changes

✨ Features

  • Add basic styling for the <mark> element (#232)

🐛 Bug Fixes

  • Making HeroLarge markup more consistent with the other hero sizes (#229)

Version 1.2.0

11 May 16:04

Choose a tag to compare

Changes

✨ Features

  • Adds HeroSmall component (#224)

🧰 Maintenance

  • Deprecating BaseIframe CSS class (#206)
  • Removing engines defined in package.json (#207)
  • Bump prettier from 2.6.1 to 2.6.2 (#205)

Version 1.1.0

01 Apr 18:44
1e9cbd6

Choose a tag to compare

Changes

✨ Features

  • Improvements to BlockLinkCard and BlockLinkTile (#173)
  • Reorganize and rename components (#171)
  • Adding responsiveness to BlockIframeEmbed (#161)

🐛 Bug Fixes

  • Update mime type for BaseImagePlaceholder background images (#167)
  • Update Tailwind config to not activate dark mode based on user's OS-level setting (#165)
  • Fixing the link to the Explorer 1 readme (#144)
  • Issue templates: fixing labels in "Feature request" template (#142)

📘 Documentation

  • Adding docs on how to test the npm package locally (#174)
  • Reorganize and rename components (#171)
  • Adding boilerplate config and documentation for Percy (#195)
  • Fixing the link to the Explorer 1 readme (#144)
  • Adding issue templates and fixing a typo in the developer's guide (#141)

🧰 Maintenance

  • Bump parcel from 2.2.1 to 2.4.1, remove postcss-preset-env (#162, #199)
  • Bump @storybook (6.4.20) and eslint-plugin-storybook (0.5.7) (#179, #198)
  • Update tailwindcss to v2.2.19 and @tailwindcss/forms to v0.5.0 (#196)
  • Adding boilerplate config and documentation for Percy (#195)
  • Bump eslint from 8.8.0 to 8.12.0 (#177, #194)
  • Bump prettier from 2.5.1 to 2.6.1 (#192)
  • Add nvmrc, Bump actions/checkout and actions/setup-node to v3 (#186)
  • Bump postcss from 8.4.6 to 8.4.12 (#180, #183)
  • Updating caniuse-lite and rebuilding dist (#182)
  • Bump browser-sync from 2.27.7 to 2.27.9 (#181)
  • Bump swiper from 8.0.2 to 8.0.7 (#170)
  • Bump @fancyapps/ui from 4.0.23 to 4.0.26 (#163)
  • Issue templates: fixing labels in "Feature request" template (#142)
  • Adding issue templates and fixing a typo in the developer's guide (#141)
  • Remove prerelease overrides for Release Drafter (#140)

Migration guide: 1.0.0 to 1.1.0

Renamed Components

Various components have been renamed, including their corresponding SCSS and JavaScript includes. You should check your projects for any of the following and update accordingly. Note that all new names are documented in the table below, but not all new names require action. Deprecated component names will be supported until the next major release.

Old name New name All users A la carte: SCSS updates A la carte: JS updates
BaseCarouselCards MixinCarousel Update CSS class name in html template Renamed to _MixinCarousel.scss Update /src/js/vendors/_swiper.js and /src/js/vendors/_swiperOptions.js. If importing exports directly from _swiperOptions, note that the export name has changed to MixinCarousel
AnimationCaret MixinAnimationCaret Update CSS class name in html template Renamed to _MixinAnimationCaret.scss N/A
BaseVideoBg MixinVideoBg N/A N/A N/A
HeroFeature HeroMedium Update CSS class name in html template Renamed to _HeroMedium.scss N/A
HeroFocalPoint HeroLarge Update CSS class name in html template Renamed to _HeroLarge.scss N/A
BlockArticleCarousel BlockLinkCarousel Update CSS class name in html template N/A N/A
BlockArticleCarouselItem BlockLinkCard N/A N/A N/A
BlockFactCards BlockCardGroup Update CSS class name in html template N/A N/A
BlockFactCardsItem BlockCard N/A N/A N/A

Recommended

If you are using Explorer 1 with a custom frontend framework, you may want to consider renaming your components, and/or creating a table documenting how your project's components map to the Explorer 1 design system.

New features added to BlockLinkCarousel

BlockLinkCarousel has a new "item type" argument. BlockLinkCard, the default selection, replicates what was formerly known as BlockArticleCarousel. A new option, BlockLinkTile, is now available as well.

BlockLinkCard and BlockLinkTile

Improvements have been made to BlockLinkCard and BlockLinkTile, including compact styles, and styles for a secondary label. Update your HTML templates as needed. If you were previously using BlockArticleCarouselItem, you will want to update to use the latest BlockLinkCard in its place.

MixinCarousel improvement

The -tile variant of MixinCarousel now includes pb-5 by default. When used in projects, the -tile variant required adding the pb-5 inline class to work properly with tiles. If this applies to your project, you can now remove the pb-5 inline class from the following selectors: .BaseCarouselCards.-tile or .MixinCarousel.-tile

Responsive BlockIframeEmbed

BlockIframeEmbed is now responsive for 16:9 embeds! To use this feature, you will need to make the following changes to your project:

  • The template for BlockIframeEmbed has changed and you will need to update the markup in your projects.
  • The scss partial for BlockIframeEmbed has been renamed to _BaseIframe.scss, so you will need to update your scss imports if you are using Explorer 1 a la carte.

Contributors

Full Changelog: 1.0.0...1.1.0

Version 1.0.0

02 Feb 23:56

Choose a tag to compare

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 to storyRoot (#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 affects BlockArticleCarousel and BlockFactCards templates as well. The navigation div, <div class="swiper-navigation lg:block">, should change lg:block to xl: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 the SwiperCore class, you will need to update your implementation to import Swiper from swiper. 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 as modules: [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