- Kotlin 90.9%
- HTML 9.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github/ISSUE_TEMPLATE | ||
| gradle/wrapper | ||
| release | ||
| screenshots | ||
| src/main | ||
| .gitignore | ||
| .sdkmanrc | ||
| build.gradle.kts | ||
| CHANGELOG.md | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| README.md | ||
| settings.gradle.kts | ||
| snippets.md | ||
| Taskfile.yml | ||
RiverpodX
Boost your Flutter development with Riverpod! This plugin enhances your workflow by offering a set of useful tools specifically designed for working with Riverpod.
Features
- GoTo Provider Declaration: Quickly navigate to the provider’s declaration.
- Find Usages for Providers: Locate all usages of a provider in the project.
- Code Snippets: Use predefined code snippets to save time. Generator snippets automatically add the
riverpod_annotationimport and the matchingpart '*.g.dart'directive if they are missing. - Convert
ConsumerWidgettoConsumerStatefulWidget(and vice versa): Easily switch between ConsumerWidget and ConsumerStatefulWidget. - Wrap with Consumer / Remove Consumer: Wrap the widget expression under the caret in a
Consumerwidget, or remove an enclosingConsumer/Consumer.builderwidget, keeping the widget it returns.
Usage
Snippets
Generator Syntax
| Shortcut | Description |
|---|---|
riverpodPart |
Creates a part statement |
generatorVariable |
Create a variable using the generator |
generatorFutureVariable |
Create a future variable using the generator |
notifierProvider |
Create a NotifierProvider using the generator |
Note: All providers can be created with
keepAliveandfamily.
Common Syntax
| Shortcut | Description |
|---|---|
consumer |
New Consumer |
consumerWidget |
New ConsumerWidget |
consumerStatefulWidget |
New ConsumerStatefulWidget |
provider* |
New Provider (suffix modifier: e.g., autoDispose) |
futureProvider* |
New FutureProvider |
when |
Handle AsyncValue using when with data, error, and loading cases |
Note: (* ) is suffix modifier, ex: autoDispose, family
For a full list of all available snippets, please check the complete list of snippets.
Installation
-
Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "RiverpodX" > Install Plugin
-
Manually:
Download the latest release and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...
Contributing
If you have suggestions or improvements for the plugin, feel free to contribute! Please follow these steps:
- Report Issues: If you encounter bugs or have ideas for improvements, please open an issue on Codeberg.
- Create a Branch: Create a new branch for your feature or bug fix.
- Make Changes: Implement your changes and ensure they align with the project's coding standards.
- Submit a Pull Request: Once your changes are ready, submit a pull request with a clear description of what you've done.
Thank you for helping improve the plugin!
Changelog
All notable changes to this project will be documented in the Changelog.
For detailed information on each release, please visit the Releases page.
License
This plugin is licensed under the Apache License Version 2.0. See the LICENSE file for more details.