Releases: nasa-jpl/explorer-1
Version 1.8.0
Version 1.7.2
Version 1.7.1
Version 1.7.0
Version 1.6.0
Changes
✨ Features
📘 Documentation
🧰 Maintenance
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
Version 1.4.0
Version 1.3.0
Version 1.2.0
Version 1.1.0
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/uifrom 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
BlockIframeEmbedhas changed and you will need to update the markup in your projects. - The scss partial for
BlockIframeEmbedhas been renamed to_BaseIframe.scss, so you will need to update your scss imports if you are using Explorer 1 a la carte.
Contributors
- @jamesray made their first contribution in #165
- @addisonhardy made their first contribution in #167
- @Scotchester
- @laespinoza
- @kaelynrichards
- @stephiescastle
Full Changelog: 1.0.0...1.1.0
