CodeField class

A widget that displays code with syntax highlighting and a copy button.

The CodeField widget takes a name parameter which is displayed as a label above the code block, and a codes parameter containing the actual code text to display.

Features:

  • Displays code in a Material container with rounded corners
  • Shows the code language/name as a label
  • Provides a copy button to copy code to clipboard
  • Visual feedback when code is copied
  • Themed colors that adapt to light/dark mode
Inheritance

Constructors

CodeField({Key? key, required String name, required String codes, CodeBlockStyle style = const CodeBlockStyle(), void onCopy(String code)?, bool highlightCode = true, bool scalesItsOwnText = false})
const

Properties

codes → String
The code itself.
final
hashCode → int
The hash code for this object.
no setterinherited
highlightCode → bool
Whether to apply syntax highlighting to the current code.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
name → String
The language written after the opening fence.
final
onCopy → void Function(String code)?
Called with the code after it is copied to the clipboard.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scalesItsOwnText → bool
Whether this block scales from MediaQuery rather than an enclosing paragraph. Leave false when embedded in a WidgetSpan.
final
style → CodeBlockStyle
Resolved appearance. Every field is already filled in.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CodeField>
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, int wrapWidth = 65}) → 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