Releases: carbon-design-system/gatsby-theme-carbon
v1.0.1
v1.0.0
New since pre-release
- Side-nav and page-tab scrolling
- homepage alignment fixes
- body copy length adjustments
- add italic plex + document italics
New in v1.0.0
- Add metadata from siteMetadata
This will automatically inject a title, description and keywords into the head of your document. Simply provide them to siteMetadata in your gatsby-config.js
file.
module.exports = {
siteMetadata: {
title: 'Gatsby Theme Carbon',
description: 'A Gatsby theme for the carbon design system',
keywords: 'gatsby,theme,carbon',
},
__experimentalThemes: [
{
resolve: 'gatsby-theme-carbon',
},
],
};
-
All of our components are global now, if it comes from us you don't need to import it at the top of your
.mdx
files~~`import { PageDescription, Row, Column } from 'gatsby-theme-carbon'`~~
- Add Link styles to markdown w/ support for local links
- Added manifest config to example w/ docs
- Add default favicon
- Update sass build: blazing fast hot module reloading and smaller bundle size
- gatsby-image: higher default image quality, and WebP for browsers that support it
- Tabs component!
Breaking
Two possible breaking changes:
-
If you were using the theme options to configure some manifest options (name, short_name, short_url, background/theme color) the preferred method is to now pass those options into the manifest plugin itself. We were just passing them in for you anyway.
This configuration is demonstrated in the example project.
-
If you're using a
carbon-components-react
component for your own custom components, you'll need to import the styles for that component.While you can just include the entire css stylesheet from carbon-components, we recommend importing just the component you need (example below). You can read more about importing Carbon's individual components' styles from our medium post here.
The new Link component demonstrates this pattern.
v1.0.0-alpha.0
v1.0.0-alpha.0
v0.7.0
Bug fixes
- Overlay and navigation state improvements
- Alignment fixes for Cards and Footer
- PageHeader height adjustments
Features
- ImageCard – Customizable image block for assembling stylized groups of links
- New
Switcher
with updated default links and styles - ArticleCard subtitle
- Email Icon for all cards
- Global Search custom hook interface
- New example doc pages for components
- Add support for Plex special characters and additional font weights
- Advanced configuration and shadowing guides
- 404 implementation
- Modifying image compression
- Global Search
- Extra font weights
Breaking changes
- Global Search is disabled by default, you'll need to turn it on and configure a custom hook for your chose search provider
- If you've shadowed/overridden components previously to accommodate for spacing issues, give the new, native, updates a try.
v0.6.1
v0.6.0
Breaking changes
<ResourceCard>
& <ArticleCard>
Updated prop names to match other components
old prop | new prop |
---|---|
dark |
color="dark |
PageDescription
PageDescription must now have white space around them. This lets you use markdown (bold, italic, etc.) in your description.
Header
+ shadowing notes
When you shadow a component, as a rule of thumb, you should spread the props into the component you’re wrapping. Otherwise, you’re essentially throwing the info we pass away and the component you’re wrapping may need those. If you're over-riding any of the props, be sure to spread the props before you provide your over-rides. Otherwise, they'll override you.
The shadow’d component doesn’t always have required props but it’s good practice to spread them in anyways, just in case some are added later.
For example, this release is likely going to break your Header
component. Its an easy fix, it should just look like the example
New
<FeatureCard>
https://gatsby-theme-carbon.now.sh/components/FeatureCard- sticky tabs
- updated documentation (still WIP)
Fixes
v0.5.2
Breaking Changes
- the root page needs to be an
index.mdx
that contains the central, core content of your homepage. It should export the homepage template:
import HomepageTemplate from 'gatsby-theme-carbon/src/templates/Homepage';
export default HomepageTemplate;
## Content starts here
- In order to customize the homepage, you should shadow the homepage template. Check out the example in the examples directory. Note: you're the shadowed component lives in the
template
directory, as apposed to thecomponents
directory in your shadowed components folder. Check out this example from the starter:
https://github.com/carbon-design-system/gatsby-theme-carbon/blob/master/packages/example/src/gatsby-theme-carbon/templates/Homepage.js
Bug fixes:
- allow top level pages with tabs
- fix left nav active styles
v0.5.1: Fix path prefixes
This fixes path prefixes for the page tabs as well as the next/previous component
v0.5.0
New
- Next / Prev buttons render by default
- Added gatsby-remark-copy-linked-files (svg and gif images should now display)
Fixes
- General grid alignment fixes
v0.4.0
New
-
blockquote default styles
-
<Aside>
component -
bumped up some dependency versions
-
HomepageTemplate
seeexample/src/gatsby-theme-carbon/templates/Homepage.js
for shadowing example -
HomepageBanner
TheHomepageBanner
component allows users to customize the text and image of the banner on the homepage.
import Carbon from '../images/jpg';
<Banner
renderText={() => (
<h1>
Carbon
<br />
Design System
</h1>
)}
image={Carbon}
/>
HomepageCallout
TheHomepageCallout
component can receive a backgroundColor and color prop. The color will first try to match one of the theme tokens (interactive01
,ui05
, etc.) before just passing the raw color value.
<Callout
leftText={() => <p>Left Text</p>}
rightText={() => <p>Right Text</p>}
color="white"
backgroundColor="activePrimary"
/>
Fixes
- Remove broken images from markdown
- Sidebar link console error
- Now deployment previews are public
- Paragraph padding
- Overflowing anchor tags stay flush