CodeBlockComponentWidget class
A widget representing a code block component.
It is highly recommended to use a monospace font for the code block, as otherwise the alignment of line numbers and lines won't match up.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- CodeBlockComponentWidget
Constructors
- CodeBlockComponentWidget({Key? key, required Node node, bool showActions = false, BlockComponentActionBuilder? actionBuilder, BlockComponentConfiguration configuration = const BlockComponentConfiguration(), EdgeInsets padding = const EdgeInsets.all(20), CodeBlockStyle? style, CodeBlockActions actions = const CodeBlockActions(), Widget actionWrapperBuilder(Node node, EditorState editorState, Widget child)?, CodeBlockLanguagePickerBuilder? languagePickerBuilder, CodeBlockCopyBuilder? copyButtonBuilder, CodeBlockLocalizations localizations = const CodeBlockLocalizations(), bool showLineNumbers = true})
-
const
Properties
- actionBuilder → BlockComponentActionBuilder?
-
finalinherited
- actions → CodeBlockActions
-
The actions available for the code block.
final
- actionWrapperBuilder → (Widget Function(Node node, EditorState editorState, Widget child)?)
-
The builder for the action widgets.
final
- configuration → BlockComponentConfiguration
-
finalinherited
- copyButtonBuilder → CodeBlockCopyBuilder?
-
Provide a custom Widget for the copy button.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- languagePickerBuilder → CodeBlockLanguagePickerBuilder?
-
Provide a custom Widget for the language picker.
final
- localizations → CodeBlockLocalizations
-
final
- node → Node
-
finalinherited
- padding → EdgeInsets
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showActions → bool
-
finalinherited
- showLineNumbers → bool
-
final
- style → CodeBlockStyle?
-
The style of the code block.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< CodeBlockComponentWidget> - Creates the mutable state for this widget at a given location in the tree.
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited