options<T> method

T options<T>({
  1. required String key,
  2. String? description,
  3. required List<Option<T>> options,
  4. int initialIndex = 0,
})

Creates Option knob.

Implementation

T options<T>({
  /// Knob node key.
  required String key,
  /// Knob node description.
  String? description,
  /// Knob node options.
  required List<Option<T>> options,
  /// Knob node initial value index.
  int initialIndex = 0,
}) {
  final knobProvider = KnobsProvider.of(this);
  final storyProvider = StoryProvider.of(this);

  final knobNode = knobProvider.knobStore.addStoryKnob(
    storyProvider.story.key,
    knobKey: key,
    knobNode: KnobNodeOptions<T>(
      key: key,
      description: description,
      options: options,
      value: options[initialIndex],
    ),
  );

  return knobNode.value.value;
}