flutter_solidart 1.0.0-dev2

flutter_solidart: ^1.0.0-dev2 copied to clipboard

The Show widget now takes a functions that returns a bool. You easily convert any type to bool, for example:

final count = createSignal(0);

@override
Widget build(BuildContext context) {
  return Show(
    when: () => count() > 5,
    builder: (context) => const Text('Count is greater than 5'),
    fallback: (context) => const Text('Count is lower than 6'),
  );
}

This is a development preview of the 1.0.0 release of solidart. The core of the library has been rewritten in order to support automatic dependency tracking like SolidJS.

• FEAT: Add automatic dependency tracking

• BREAKING CHANGE: To create derived signals now you should use createComputed instead of signalName.select This allows you to derive from many signals instead of only 1.

  Before:

  final count = createSignal(0);
  final doubleCount = count.select((value) => value * 2);
  

  Now:

  final count = createSignal(0);
  final doubleCount = createComputed(() => count() * 2);
  

• FEAT: The createEffect no longer needs a signals array, it automatically track each signal.

  Before:

  final effect = createEffect(() {
    print('The counter is now ${counter.value}');
  }, signals: [counter]);
  

  Now:

  final disposeFn = createEffect((disposeFn) {
    print('The counter is now ${counter.value}');
  })
  

• BREAKING CHANGE: The createEffect method no longer returns an Effect, you cannot pause or resume it anymore. Instead it returns a Dispose callback which you can call when you want to stop it. You can also dispose an effect from the inside of the callback.

• BREAKING CHANGE: The fireImmediately field on effects has been removed. Now an effect runs immediately by default.

• FEAT: Add observe method on Signal. Use it to easily observe the previous and current value instead of creating an effect.

  final count = createSignal(0);
  final disposeFn = count.observe((previousValue, value) {
    print('The counter changed from $previousValue to $value');
  }, fireImmediately: true);
  

• FEAT: Add until method on Signal. It returns a future that completes when the condition evalutes to true and it returns the current signal value.

  final count = createSignal(0);
  // wait until the count is greater than 5
  final value = await count.until((value) => value > 5);
  

• FEAT: Add untilReady method on Resource. Now you can wait until the resource is ready.

  final resource = createResource(..);
  final data = await resource.untilReady();
  

• FEAT: The Resource now accepts ResourceOptions. You can customize the lazy value of the resource (defaults to true), if you want your resource to resolve immediately.

• CHORE: ResourceValue has been renamed into ResourceState. Now you can get the state of the resource with the state getter.

• FEAT: Add toValueNotifier() extension to Signal to easily convert it to a ValueNotifier.

• FEAT: Add toSignal() extension to ValueNotifier to easily convert it to a Signal.

• BUGFIX: The Show widget now can work again with a ReadSignal.

• CHORE: The ResourceBuilder now correctly handles a different Resource when the widget is updated.

• BUGFIX: Listening to the source of a Resource was not stopped when the source disposed.
• BUGFIX: A Resource would not perform the asynchronous operation until someone called the fetch method, typically the ResourceBuilder widget. This did not apply to the stream which was listened to when the resource was created. Now the behaviour has been merged and the fetch method has been renamed into resolve.
• CHORE: Renamed ReadableSignal into ReadSignal.
• CHORE: Renamed the readable method of a Signal into toReadSignal()

• Add update extension on BuildContext. It's a convenience method to update a Signal value.

  You can use it to update a signal value, e.g:

  context.update<int>('counter', (value) => value * 2);
  

  This is equal to:

  // retrieve the signal
  final signal = context.get<Signal<int>>('counter');
  // update the signal
  signal.update((value) => value * 2);
  

  but shorter when you don't need the signal for anything else.

• Add assert to resource fetch method to prevent multiple fetches of the same resource.
• Fix ResourceBuilder that fetched the resource every time even if the resource was already resolved.

• The select method of a signal now can take a custom options parameter to customize its behaviour.
• Fixed an invalid assert in the ResourceBuilder widget that happens for resources without a fetcher.

• Now Solid can deal also with SolidProviders. You no longer need an external dependency injector library. I decided to put some boundaries and stop suggesting any external dependency injector library. This choice is due to the fact that external libraries in turn provide state management and the user is more likely to mistakenly use solidart. I simplified the usage of InheritedWidgets with a very nice API:

  Declare providers #

  Solid(
        providers: [
          SolidProvider<NameProvider>(
            create: () => const NameProvider('Ale'),
            // the dispose method is fired when the [Solid] widget above is removed from the widget tree.
            dispose: (provider) => provider.dispose(),
          ),
          SolidProvider<NumberProvider>(
            create: () => const NumberProvider(1),
            // Do not create the provider lazily, but immediately
            lazy: false,
          ),
        ],
        child: const SomeChildThatNeedsProviders(),
    )
  

  Retrieve providers #

  final nameProvider = context.get<NameProvider>();
  final numberProvider = context.get<NumberProvider>();
  

  Provide providers to modals (dialogs, bottomsheets) #

    return showDialog(
      context: context,
      builder: (dialogContext) => Solid.value(
        // pass a context that has access to providers
        context: context,
        // pass the list of provider [Type]s
        providerTypes: const [NameProvider],
        child: Dialog(
          child: Builder(builder: (innerContext) {
            // retrieve the provider with the innerContext
            final nameProvider = innerContext.get<NameProvider>();
            return SizedBox.square(
              dimension: 100,
              child: Center(
                child: Text('name: ${nameProvider.name}'),
              ),
            );
          }),
        ),
      ),
    );
  

  You cannot provide multiple providers of the same type in the same Solid widget.

• createResource now accepts a stream and can be used to wrap a Stream and correctly handle its state.

• Get a signal value with signalName().

• Add documentation link inside the pubspec

• Documentation improvements
• Refactor Resource, now the createResource method takes only 1 generic, the type of the future result.

  // before
  final resource = createResource<SourceValueType, FetcherValueType>(fetcher: fetcher, source: source);
  // now
  final resource = createResource<FetcherValueType>(fetcher: fetcher, source: source); // the FetcherValueType can be inferred by Dart >=2.18.0, so you can omit it
  

• Add official documentation link
• Fix typo in fireImmediately argument name

• Now Solid.value takes a list of [signalIds] and a [BuildContext]. You don't need anymore to get the signal first and pass it to Solid.value.
• Set the minimum Dart SDK version to 2.18.

• Update Readme

• Add code coverage

• Implement Solid.value to be able to pass Signals to modals

• Add links to examples

• Specify the type of resource to the ResourceBuilder

• Decrease minimum Dart version to 2.17.0

• Fix home page link

• Initial version