ReadmeConfig class

Consumer-owned marketing content of the root-README "Performance" section (manifest readme:; rendered by contract readme from the store). The consumer picks which solutions form the table columns and writes the prose; the package renders rows/values with the canonical defs (lib/defs.dart).

Constructors

ReadmeConfig({required String target, required String intro, required List<ReadmeColumn> columns, required String footnote, String title = 'Performance', String? image, String? imageAlt, String? stamp, String? chartsUrl})
const

Properties

chartsUrl → String?
URL of the consumer's trend-charts page (github-action-benchmark gh- pages); rendered as a link under the table when present.
final
columns → List<ReadmeColumn>
Table columns (solution → golden refs), left to right.
final
footnote → String
Footnote under the table.
final
hashCode → int
The hash code for this object.
no setterinherited
image → String?
Metrics-card image path, relative to target's file.
final
imageAlt → String?
Markdown alt text of image.
final
intro → String
Prose paragraph under the heading.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stamp → String?
Stamped line under the image; {ts} replaced at render time.
final
target → String
README file path, relative to the consumer root.
final
title → String
Heading text (## Performance by default).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited