Skip to content

Commit e4c087e

Browse files
committed
Update docs
1 parent a86efa7 commit e4c087e

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,9 @@ The returned component accepts a `theme` and `composeTheme` apart from the prop
162162

163163
- `Identifier` *(String)* used to provide a unique identifier to the component that will be used to get a theme from context.
164164
- `[defaultTheme]` (*Object*) is classname object resolved from CSS modules. It will be used as the default theme to calculate a new theme that will be passed to the component.
165-
- `[options]` (*Object*) is an option object that for now only accepts one value: `composeTheme` which accepts:
166-
- `deeply` to deeply merge themes.
167-
- `softly` to softly merge themes.
168-
- `false` to disable theme merging.
165+
- `[options]` (*Object*) If specified it allows to customize the behavior:
166+
- [`composeTheme = 'deeply'`] *(String)* allows to customize the way themes are merged or to disable merging completely. The accepted values are `deeply` to deeply merge themes, `softly` to softly merge themes and `false` to disable theme merging.
167+
- [`withRef = false`] *(Boolean)* if true, stores a ref to the wrapped component instance and makes it available via `getWrappedInstance()` method. Defaults to false.
169168

170169
## About
171170

0 commit comments

Comments
 (0)