Skip to content

A cross platform Audiobookshelf client for Android and iOS

Dart
1.0 KB
Raw Blame
import 'package:flutter_carplay/models/grid/grid_button.dart';
import 'package:uuid/uuid.dart';

import '../template.dart';

/// A template object that displays and manages a grid of items.
class CPGridTemplate implements CPTemplate {
  /// Unique id of the object.
  final String _elementId = const Uuid().v4();

  /// A title will be shown in the navigation bar.
  final String title;

  /// The array of grid buttons as [CPGridButton] displayed on the template.
  final List<CPGridButton> buttons;

  /// Creates [CPGridTemplate] in order to display a grid of items as buttons.
  /// When creating the grid template, provide an array of [CPGridButton] objects.
  /// Each button must contain a title that is shown in the grid template's navigation bar.
  CPGridTemplate({required this.title, required this.buttons});

  @override
  Map<String, dynamic> toJson() => {
        '_elementId': _elementId,
        'title': title,
        'buttons': buttons.map((e) => e.toJson()).toList(),
      };

  @override
  String get uniqueId {
    return _elementId;
  }
}