refactor: make KnobsBuilder.onKnobAdded public (#727)

widgetbook · Jun 7, 2023 · 842c6fa · 842c6fa
1 parent e77a797
commit 842c6fa
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 20 deletions.
diff --git a/packages/widgetbook/CHANGELOG.md b/packages/widgetbook/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## Unreleased
 
  - **REFACTOR**: Export `WidgetbookState`. ([#724](https://github.com/widgetbook/widgetbook/pull/724))
+ - **REFACTOR**: Make `KnobsBuilder.onKnobAdded` public. ([#727](https://github.com/widgetbook/widgetbook/pull/727))
  - **FIX**: Use related type checks when comparing device's frame state to its query parameter. ([#715](https://github.com/widgetbook/widgetbook/pull/715))
  - **FIX**: Add missing type parameter to `LabelBuilder`, which affected the `list` knob. ([#718](https://github.com/widgetbook/widgetbook/pull/718))
  - **FIX**: Add `key` to use cases to prevent out-of-sync builds. ([#720](https://github.com/widgetbook/widgetbook/pull/720))

diff --git a/packages/widgetbook/lib/src/knobs/builders/double_knobs_builder.dart b/packages/widgetbook/lib/src/knobs/builders/double_knobs_builder.dart
@@ -3,11 +3,9 @@ import '../double_slider_knob.dart';
 import 'knobs_builder.dart';
 
 class DoubleKnobsBuilder {
-  DoubleKnobsBuilder(
-    KnobAdded onKnobAdded,
-  ) : this._onKnobAdded = onKnobAdded;
+  DoubleKnobsBuilder(this.onKnobAdded);
 
-  final KnobAdded _onKnobAdded;
+  final KnobAdded onKnobAdded;
 
   /// Creates a slider that can be slid to specific double values. You can use
   /// the `num.toInt()` function to make this into an integer
@@ -20,7 +18,7 @@ class DoubleKnobsBuilder {
     int? divisions,
   }) {
     initialValue ??= max ?? min ?? 10;
-    return _onKnobAdded(
+    return onKnobAdded(
       DoubleSliderKnob(
         label: label,
         value: initialValue,
@@ -39,7 +37,7 @@ class DoubleKnobsBuilder {
     String? description,
     double initialValue = 0,
   }) {
-    return _onKnobAdded(
+    return onKnobAdded(
       DoubleInputKnob(
         label: label,
         value: initialValue,
@@ -52,9 +50,9 @@ class DoubleKnobsBuilder {
 class DoubleOrNullKnobsBuilder {
   DoubleOrNullKnobsBuilder(
     KnobAdded onKnobAdded,
-  ) : this._onKnobAdded = onKnobAdded;
+  ) : this.onKnobAdded = onKnobAdded;
 
-  final KnobAdded _onKnobAdded;
+  final KnobAdded onKnobAdded;
 
   /// Creates a slider that can be slid to specific double values. You can use
   /// the `num?.toInt()` function to make this into an integer.
@@ -68,7 +66,7 @@ class DoubleOrNullKnobsBuilder {
     int? divisions,
   }) {
     initialValue ??= max ?? min ?? 10;
-    return _onKnobAdded<double?>(
+    return onKnobAdded<double?>(
       DoubleOrNullSliderKnob(
         label: label,
         value: initialValue,
@@ -88,7 +86,7 @@ class DoubleOrNullKnobsBuilder {
     String? description,
     double? initialValue,
   }) {
-    return _onKnobAdded<double?>(
+    return onKnobAdded<double?>(
       DoubleOrNullInputKnob(
         label: label,
         value: initialValue,

diff --git a/packages/widgetbook/lib/src/knobs/builders/knobs_builder.dart b/packages/widgetbook/lib/src/knobs/builders/knobs_builder.dart
@@ -12,12 +12,11 @@ typedef KnobAdded = T? Function<T>(Knob<T> knob);
 
 class KnobsBuilder {
   KnobsBuilder(
-    KnobAdded onKnobAdded,
-  )   : this._onKnobAdded = onKnobAdded,
-        this.double = DoubleKnobsBuilder(onKnobAdded),
+    this.onKnobAdded,
+  )   : this.double = DoubleKnobsBuilder(onKnobAdded),
         this.doubleOrNull = DoubleOrNullKnobsBuilder(onKnobAdded);
 
-  final KnobAdded _onKnobAdded;
+  final KnobAdded onKnobAdded;
   final DoubleKnobsBuilder double;
   final DoubleOrNullKnobsBuilder doubleOrNull;
 
@@ -27,7 +26,7 @@ class KnobsBuilder {
     String? description,
     bool initialValue = false,
   }) {
-    return _onKnobAdded(
+    return onKnobAdded(
       BooleanKnob(
         label: label,
         description: description,
@@ -43,7 +42,7 @@ class KnobsBuilder {
     String? description,
     bool? initialValue = false,
   }) {
-    return _onKnobAdded<bool?>(
+    return onKnobAdded<bool?>(
       BooleanOrNullKnob(
         label: label,
         description: description,
@@ -59,7 +58,7 @@ class KnobsBuilder {
     required Color initialValue,
     String? description,
   }) {
-    return _onKnobAdded(
+    return onKnobAdded(
       ColorKnob(
         label: label,
         value: initialValue,
@@ -74,7 +73,7 @@ class KnobsBuilder {
     String initialValue = '',
     int? maxLines = 1,
   }) {
-    return _onKnobAdded(
+    return onKnobAdded(
       StringKnob(
         label: label,
         value: initialValue,
@@ -92,7 +91,7 @@ class KnobsBuilder {
     String? initialValue,
     int? maxLines = 1,
   }) {
-    return _onKnobAdded<String?>(
+    return onKnobAdded<String?>(
       StringOrNullKnob(
         label: label,
         value: initialValue,
@@ -112,7 +111,7 @@ class KnobsBuilder {
     LabelBuilder<T>? labelBuilder,
   }) {
     assert(options.isNotEmpty, 'Must specify at least one option');
-    return _onKnobAdded(
+    return onKnobAdded(
       ListKnob(
         label: label,
         value: options.first,