SearchGroup class

Represents a group or category of search items.

Groups allow organizing search results into logical categories for better user experience. Each group can be expanded or collapsed in the UI.

Inheritance
Annotations

Constructors

SearchGroup.new({required String id, required String name, String? description, int? icon, int? color, int priority = 0})
Creates a search group.

Properties

box BoxBase?
Get the box in which this object is stored. Returns null if object has not been added to a box yet.
no setterinherited
color int?
Optional color value for the group.
final
description String?
Optional description of what items belong to this group.
final
hashCode int
The hash code for this object.
no setteroverride
icon int?
Optional icon data for the group.
final
id String
Unique identifier for this group.
final
isInBox bool
Returns whether this object is currently stored in a box.
no setterinherited
key → dynamic
Get the key associated with this object. Returns null if object has not been added to a box yet.
no setterinherited
name String
Display name of the group.
final
priority int
Priority for sorting groups (higher priority appears first).
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

copyWith({String? id, String? name, String? description, int? icon, int? color, int? priority}) SearchGroup
Creates a copy of this group with updated fields.
delete() Future<void>
Deletes this object from the box it is stored in.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
save() Future<void>
Persists this object.
inherited
toString() String
A string representation of this object.
override

Operators

operator ==(Object other) bool
The equality operator.
override