GiphySheet class

Contains the GIPHY UI components

Inheritance

Constructors

GiphySheet.new({Key? key, required GiphyClient client, required GiphyRequest request, Widget gridBuilder(BuildContext context, GiphySource source, void onSelected(GiphyGif))?, Widget errorBuilder(BuildContext context, dynamic error, StackTrace? stackTrace)?, InputDecoration? searchInputDecoration, String? searchLabelText, String? searchHintText, String? searchEmptyResultText, String? searchCancelText, void onSelected(GiphyGif gif)?, Widget? attribution, bool showAttribution = true, bool showSearch = true, bool showTypeSwitcher = true, bool showPreview = false, bool keepState = false, String? headerGifsText, String? headerStickersText, String? headerEmojiText, double gridSpacing = 2.0, BorderRadius? gridBorderRadius, BorderRadius? previewBorderRadius, ScrollController? scrollController, int gridMinColumns = 2, GridType gridType = GridType.stackedColumns})
Creates a new GiphySheet
const

Properties

attribution Widget?
The attribution visualization
final
client GiphyClient
The giphy client
final
errorBuilder Widget Function(BuildContext context, dynamic error, StackTrace? stackTrace)?
Sliver builder that is invoked when no GIFs could be loaded
final
gridBorderRadius BorderRadius?
The border radius for images shown in the grid
final
gridBuilder Widget Function(BuildContext context, GiphySource source, void onSelected(GiphyGif))?
Sliver builder responsible for creating the visual representation of the given source
final
gridMinColumns int
The minimum number of columns, defaults to 4
final
gridSpacing double
The spacing between the individual grid tiles
final
gridType GridType
The type of the predefined grids
final
hashCode int
The hash code for this object.
no setterinherited
headerEmojiText String?
The text for emoji
final
headerGifsText String?
The text for GIFs
final
headerStickersText String?
The text for stickers
final
keepState bool
When true the state is kept in a static variable to subsequent calls.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onSelected → void Function(GiphyGif gif)?
Method that is informed about the selection of an image
final
previewBorderRadius BorderRadius?
The border radius for an image shown in a preview alert
final
request GiphyRequest
The current request to giphy
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollController ScrollController?
Optional scroll controller in case this sheet is embedded in a linked scrolling experience like a DraggableScrollableSheet
final
searchCancelText String?
The text to cancel the search
final
searchEmptyResultText String?
The text shown when the search yielded no result
final
searchHintText String?
The hint shown in an empty search field
final
searchInputDecoration InputDecoration?
The decoration for the input field
final
searchLabelText String?
The label for the search field
final
showAttribution bool
Should attribution be shown?
final
showPreview bool
Should a bigger preview of the selected image been shown before the user can select it?
final
showSearch bool
Should the search be shown?
final
showTypeSwitcher bool
Should the switch between GIFs, stickers and emoji been shown?
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _GiphySheetState
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