LyricsRenderer class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- LyricsRenderer
Constructors
- LyricsRenderer({Key? key, required String lyrics, required TextStyle textStyle, required TextStyle chordStyle, required Function onTapChord, TextStyle? chorusStyle, TextStyle? capoStyle, double scaleFactor = 1.0, bool showChord = true, int widgetPadding = 0, int transposeIncrement = 0, int scrollSpeed = 0, double lineHeight = 8.0, CrossAxisAlignment horizontalAlignment = CrossAxisAlignment.center, ScrollPhysics scrollPhysics = const ClampingScrollPhysics(), Widget? leadingWidget, Widget? trailingWidget, ChordNotation chordNotation = ChordNotation.american})
-
const
Properties
- capoStyle → TextStyle?
-
If not defined it will be the italic version of textStyle
final
- chordNotation → ChordNotation
-
Notation that will be handled by the transposer
final
- chordStyle → TextStyle
-
final
- chorusStyle → TextStyle?
-
If not defined it will be the bold version of textStyle
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- horizontalAlignment → CrossAxisAlignment
-
Horizontal alignment
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- leadingWidget → Widget?
-
Widget before the lyrics starts
final
- lineHeight → double
-
Extra height between each line
final
- lyrics → String
-
final
- onTapChord → Function
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scaleFactor → double
-
Scale factor of chords and lyrics
final
- scrollPhysics → ScrollPhysics
-
Define physics of scrolling
final
- scrollSpeed → int
-
Auto Scroll Speed,
default value is 0, which means no auto scroll is applied
final
- showChord → bool
-
final
- textStyle → TextStyle
-
final
- trailingWidget → Widget?
-
Widget after the lyrics finishes
final
- transposeIncrement → int
-
Transpose Increment for the Chords,
default value is 0, which means no transpose is applied
final
- widgetPadding → int
-
To help stop overflow, this should be the sum of left & right padding
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< LyricsRenderer> -
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