Skip to content

Commit 66f9d9b

Browse files
Laurie BarthLaurie Barth
authored andcommitted
remove optional moduleExportName and align on default
1 parent f2496a8 commit 66f9d9b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/gatsby-plugin-theme-ui/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ prevent a flash of unstyled colors when using color modes.
2222
| ------------------------ | ---------------- | -------------------------------------------------------------------------------- |
2323
| `themeModule` | `null` | JSON theme object, use the `require` syntax to include it in options. Make sure the package you're requiring is installed in your dependencies. |
2424
| `themeModulePath` | `null` | A string package name that the plugin will require for you. Make sure the package you're requiring is installed in your dependencies. |
25-
| `moduleExportName` | `default` | The name of the export from the theme module, applies to `themeModule` or `themeModulePath` resolution depending which one you're using |
2625

27-
> Note that if your theme is exported at the top level, the `moduleExportName` of `default` is bypassed. See [theme-ui/preset-deep](https://github.com/system-ui/theme-ui/blob/master/packages/preset-deep/src/index.ts).
26+
27+
> Note that this plugin assumes the theme object is exported as `default`.
2828
2929
The theme module you include in options is considered your base theme. Any further customization and shadowing will be merged with it.
3030

0 commit comments

Comments
 (0)