AwsMarkdownFloatingMenu class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AwsMarkdownFloatingMenu
Constructors
- AwsMarkdownFloatingMenu({Key? key, required bool useIncludedTextField, TextEditingController? controller, FocusNode? focusNode, bool collapsable = true, bool alignCollapseButtonEnd = false, bool flipCollapseButtonIcon = false, Color backgroundColor = const Color(0xFFEEEEEE), Color dropdownTextColor = Colors.blue, Color iconColor = const Color(0xFF303030), double iconSize = 24.0, BorderRadius borderRadius = const BorderRadius.all(Radius.circular(6.0)), double width = 60.0, double height = 40.0, double spacing = 4.0, double runSpacing = 4.0, WrapAlignment alignment = WrapAlignment.end, String boldCharacter = '**', String italicCharacter = '*', String codeCharacter = '```', String bulletedListCharacter = '-', String horizontalRuleCharacter = '---', bool hideHeading = false, bool hideBold = false, bool hideItalic = false, bool hideStrikethrough = false, bool hideLink = false, bool hideImage = false, bool hideCode = true, bool hideBulletedList = false, bool hideNumberedList = false, bool hideCheckbox = true, bool hideQuote = false, bool hideHorizontalRule = false, bool showTooltips = true, String headingTooltip = 'Heading', String boldTooltip = 'Bold', String italicTooltip = 'Italic', String strikethroughTooltip = 'Strikethrough', String linkTooltip = 'Link', String imageTooltip = 'Image', String codeTooltip = 'Code', String bulletedListTooltip = 'Bulleted list', String numberedListTooltip = 'Numbered list', String checkboxTooltip = 'Checkbox', String quoteTooltip = 'Quote', String horizontalRuleTooltip = 'Horizontal rule'})
-
Creates a AwsMarkdownFloatingMenu widget.
const
Properties
- alignCollapseButtonEnd → bool
-
Align the collapse button at the end. Default:
false
.final - alignment → WrapAlignment
-
Set the WrapAlignment of the buttons. Default:
WrapAlignment.end
.final - backgroundColor → Color
-
Set the backgroundColor of the buttons. Default:
Colors.grey[200]
final - boldCharacter → String
-
If you want to use an alternative bold character (Default:
**
), assign a custom String to boldCharacter. For example__
final - boldTooltip → String
-
Set a custom tooltip String for the bold button. Leave blank
''
to disable tooltip.final - borderRadius → BorderRadius
-
Set the borderRadius of the buttons. Default:
BorderRadius.all(Radius.circular(6.0))
final - bulletedListCharacter → String
-
If you want to use an alternative bulleted list character (Default:
-
), assign a custom String to bulletedListCharacter. For example*
final - bulletedListTooltip → String
-
Set a custom tooltip String for the bulleted list button. Leave blank
''
to disable tooltip.final - checkboxTooltip → String
-
Set a custom tooltip String for the checkbox button. Leave blank
''
to disable tooltip.final - codeCharacter → String
-
If you want to use an alternative code character (Default:
```
), assign a custom String to codeCharacter. For example`
final - codeTooltip → String
-
Set a custom tooltip String for the code button. Leave blank
''
to disable tooltip.final - collapsable → bool
-
Make the toolbar collapsable with a button by setting collapsable to
true
.final - controller → TextEditingController?
-
In order to use a custom TextField, assign a TextEditingController to the controller field.
final
- dropdownTextColor → Color
-
Set the dropdownTextColor of the buttons. Default:
Colors.blue
final - flipCollapseButtonIcon → bool
-
Flip the collapse button icon. Default:
false
.final - focusNode → FocusNode?
-
If using a custom TextField, set the focusNode to a FocusNode Widget in order
to focus the text after clicking a button. Use the FocusNode like this:
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- headingTooltip → String
-
Set a custom tooltip String for the heading button. Leave blank
''
to disable tooltip.final - height → double
-
Set the height of the buttons. Default:
40
.final - hideBold → bool
-
Hide the bold button by setting hideBold to
true
.final - hideBulletedList → bool
-
Hide the bulleted list button by setting hideBulletedList to
true
.final - hideCheckbox → bool
-
Hide the checkbox button by setting hideCheckbox to
true
.final - hideCode → bool
-
Hide the code button by setting hideCode to
true
.final - hideHeading → bool
-
Hide the heading button by setting hideHeading to
true
.final - hideHorizontalRule → bool
-
Hide the horizontal rule button by setting hideHorizontalRule to
true
.final - hideImage → bool
-
Hide the image button by setting hideImage to
true
.final - hideItalic → bool
-
Hide the italic button by setting hideItalic to
true
.final - hideLink → bool
-
Hide the link button by setting hideLink to
true
.final - hideNumberedList → bool
-
Hide the numbered list button by setting hideNumberedList to
true
.final - hideQuote → bool
-
Hide the quote button by setting hideQuote to
true
.final - hideStrikethrough → bool
-
Hide the strikethrough button by setting hideStrikethrough to
true
.final - horizontalRuleCharacter → String
-
If you want to use an alternative horizontal rule character (Default:
---
), assign a custom String to horizontalRuleCharacter. For example***
final - horizontalRuleTooltip → String
-
Set a custom tooltip String for the horizontal rule button. Leave blank
''
to disable tooltip.final - iconColor → Color
-
Set the iconColor of the buttons. Default:
Colors.grey[850]
final - iconSize → double
-
Set the iconSize of the buttons. Default:
24
final - imageTooltip → String
-
Set a custom tooltip String for the image button. Leave blank
''
to disable tooltip.final - italicCharacter → String
-
If you want to use an alternative italic character (Default:
*
), assign a custom String to italicCharacter. For example_
final - italicTooltip → String
-
Set a custom tooltip String for the italic button. Leave blank
''
to disable tooltip.final - key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- linkTooltip → String
-
Set a custom tooltip String for the link button. Leave blank
''
to disable tooltip.final - numberedListTooltip → String
-
Set a custom tooltip String for the numbered list button. Leave blank
''
to disable tooltip.final - quoteTooltip → String
-
Set a custom tooltip String for the quote button. Leave blank
''
to disable tooltip.final - runSpacing → double
-
Set the vertical runSpacing of the buttons. Default:
4.0
.final - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showTooltips → bool
-
Disable all tooltips by setting showTooltips to
false
. Default:true
.final - spacing → double
-
Set the horizontal spacing of the buttons. Default:
4.0
.final - strikethroughTooltip → String
-
Set a custom tooltip String for the strikethrough button. Leave blank
''
to disable tooltip.final - useIncludedTextField → bool
-
It is recommended that you use your own TextField outside this widget for more customization.
To do that, set useIncludedTextField to
false
and implement your own TextField outside. IMPORTANT: Remember to set the same controller and focusNode in the TextField as the ones in your AwsMarkdownFloatingMenu. Hover over the 2 fields for more details.final - width → double
-
Set the width of the buttons. Default:
60
.final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< AwsMarkdownFloatingMenu> -
Creates the mutable state for this widget at a given location in the tree.
override
-
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