Security News
Internet Archive Hacked, 31 Million Record Compromised
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
gatsby-plugin-theme-ui
Advanced tools
Gatsby plugin for adding Theme UI context
Gatsby plugin for adding Theme UI context
npm i theme-ui gatsby-plugin-theme-ui
// gatsby-config.js
module.exports = {
plugins: ['gatsby-plugin-theme-ui'],
}
In addition to providing context, this plugin will also prevent a flash of unstyled colors when using color modes.
Key | Default value | Description |
---|---|---|
prismPreset | null | The name of the preset you'd like to use to style code blocks inside your markdown files. The available presets can be found in the theme-ui docs. You can also use a package string of your own choosing. |
preset | null | This can be a JSON theme object or a string package name. Make sure the package you're requiring is installed in your dependencies. |
injectColorFlashScript | true | By default, the plugin injects a script tag to prevent color mode flashing. Set this option to false to omit the script. Useful for AMP (Accelerated Mobile Pages) pages. |
Note that this plugin assumes the theme object is exported as
default
.
The theme module you include in options is considered your base theme. Any further customization and shadowing will be merged with it.
// gatsby-config.js
module.exports = {
plugins: [
{
resolve: 'gatsby-plugin-theme-ui',
options: {
prismPreset: 'night-owl',
preset: '@theme-ui/preset-funk',
},
},
],
}
To customize the theme used in your Gatsby site,
shadow the src/gatsby-plugin-theme-ui/index.js
module.
export default {
colors: {
text: '#111',
background: '#fff',
},
}
If you prefer to load your theme from a custom path (instead of the standard src/gatsby-plugin-theme-ui/index.js
),
you can require it in your gatsby-config.js
file:
module.exports = {
plugins: [
{
resolve: 'gatsby-plugin-theme-ui',
options: {
preset: require('./src/theme'),
},
},
],
}
Note that gatsby-config.js
does not support ES6 modules, so you should use module.exports
in your theme file:
module.exports = {
colors: {
text: '#111',
background: '#fff',
},
}
To extend a Gatsby theme that uses Theme UI, import the base theme and export a new theme object.
import baseTheme from 'gatsby-theme-blog/src/gatsby-plugin-theme-ui'
export default {
...baseTheme,
colors: {
...baseTheme.colors,
text: '#111',
background: '#fff',
},
}
You can also import and use presets from @theme-ui/presets to use as a starting point.
To enable support for multiple color modes, add a nested modes
object to theme.colors
.
export default {
colors: {
text: '#000',
background: '#fff',
modes: {
dark: {
text: '#fff',
background: '#000',
},
},
},
}
Custom MDX components that will receive styles from the theme can be included by adding a src/gatsby-plugin-theme-ui/components.js
module.
export default {
h1: (props) => (
<h1 {...props}>
<a href={`#${props.id}`}>{props.children}</a>
</h1>
),
}
MIT License
FAQs
Gatsby plugin for adding Theme UI context
The npm package gatsby-plugin-theme-ui receives a total of 3,003 weekly downloads. As such, gatsby-plugin-theme-ui popularity was classified as popular.
We found that gatsby-plugin-theme-ui demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
Security News
TC39 is meeting in Tokyo this week and they have approved nearly a dozen proposals to advance to the next stages.
Security News
Our threat research team breaks down two malicious npm packages designed to exploit developer trust, steal your data, and destroy data on your machine.