The API reference is a Work in Progress and will be continuously improved and extended. We'd love to hear your feedback in our documentation repository.

Home > @edtr-io/ui

ui package

Provides utils for the User Interface

Functions

FunctionDescription
createEditorUiTheme(key, createDefaultTheme)Creates a function that maps EditorThemeProps to the current theme of the specified editor UI component
createIcon(i)Creates an icon component
createRendererUiTheme(key, createDefaultTheme)Creates a function that maps RendererThemeProps to the current theme of the specified renderer UI component
EdtrIcon(props)Edtr.io icon component
Icon(props)Font Awesome Icon component
RootThemeProvider(props)Provider to hydrate the context for the Theme
ThemeProvider(props)Provider to override the current theme
useEditorTheme()React Hook for the editor theming
useEditorUiTheme(key, createDefaultTheme)React Hook for the theme of an editor UI component
useRendererTheme()React Hook for the renderer theming
useRendererUiTheme(key, createDefaultTheme)React Hook for the theme of a renderer UI component
useTheme()React Hook to get the current Theme

Interfaces

InterfaceDescription
EditorTheme
EditorUiTheme
RendererTheme
RendererUiTheme
ThemeInterface of an Edtr.io theme

Variables

VariableDescription
defaultEditorTheme
defaultRendererTheme
edtrAlignBlock
edtrAlignCenter
edtrAlignLeft
edtrAlignRight
edtrBold
edtrClose
edtrColorText
edtrDefaultPlugin
edtrDragHandle
edtrFill
edtrFormula
edtrItalic
edtrLink
edtrListBullets
edtrListNumbered
edtrPlus
edtrQuote
edtrSearch
edtrText
styledRe-export of `styled` in `styled-components`
ThemeContextContext used for the Theme, see also Theming

Type Aliases

Type AliasDescription
CustomThemeHelper type to be used to override the theme
DeepPartial
EditorThemeProps
EditorUiThemeFactory
RendererThemeProps
RendererUiThemeFactory
ThemePropsProps that any styled-components automatically receive, see also Theming