Skip to content

Latest commit

 

History

History
110 lines (96 loc) · 6.6 KB

scribing-react.md

File metadata and controls

110 lines (96 loc) · 6.6 KB

Home > scribing-react

scribing-react package

React components for collaborative rich text editing

Classes

Class Description
DeferrableEvent
FlowEditorController
FlowEditorState Immutable state record for a flow content editor
FormatMarkupAttributeEvent
InitEditorEvent
LoadAssetEvent
RenderableMarkup
RenderMarkupEvent
RenderMarkupTagEvent
ResolveLinkEvent
StateChangeEvent
StoreAssetEvent

Functions

Function Description
ApplicationErrorRenderScope(props)
createImageSource(blob, upload)
createImageSource(existingUrl)
formatMessage(message, vars, options)
InteractionLoggerScope(props)
useApplicationErrorRenderer()
useDataIconPacks()
useDataIcons(pack, tag)
useDataIconTags(pack)
useDefaultScriptFunctions() Gets default functions that should be exposed to script hosts
useFlowEditorClient(url, options)
useFlowEditorClient(protocol, options)
useFlowLocale()
useFlowPalette()
useFlowTypography()
useInteractionLogger()

Interfaces

Interface Description
ApplicationErrorRenderScopeProps
ApplyMineOptions Options for the FlowEditorState.applyMine() method
DataIconProps
DefaultScriptFunctions Default script functions
FlowEditorClient
FlowEditorClientOptions
FlowEditorProps Component props for FlowEditor
FlowEditorStateData Data for FlowEditorState
FlowEditorStateProps Properties for FlowEditorState
FlowLocale
FlowLocaleScopeProps
FlowPalette
FlowPaletteScopeProps
FlowTypography
FlowTypographyScopeProps
FlowViewProps Component props for FlowView
FormatMessageOptions
InteractionLoggerScopeProps
LinkArgs
LinkOpener
NestedFlowViewProps
ScribingButtonProps
ScribingComponents
ScribingImageZoomProps
ScribingTooltipProps

Variables

Variable Description
DataIcon
DefaultFlowLocale
DefaultFlowPalette
DefaultFlowTypography
DefaultScribingComponents
FlowEditor Flow editor component
FlowEditorStateBase The base record class for FlowEditorState
FlowLocaleScope
FlowPaletteScope
FlowTypographyScope
FlowView Flow content view component
NestedFlowView
ScribingComponentOverride
SharedListCounterScope Nested <FlowView> components use a shared counter for list items on level 1
useIsInsideSharedListCounterScope
useScribingComponents

Type Aliases

Type Alias Description
ApplicableChange
BooleanTextStyleKeys
ConnectionStatus
InteractionLogger
LinkAction
MarkupContext
RenderMarkupTagDisplay
ScribingComponent