Wyatt-FOSS/wyatt-packages
6
2
Fork 0
Code Issues 20 Pull Requests 4 Actions Packages Projects Releases Activity

docs(component_copy_with): add some documentation

Browse Source
This commit is contained in:
hugo
2023-04-13 23:29:27 +02:00
parent 7606d26aac
commit 5fe8d84cf6
8 changed files with 104 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/wyatt_component_copy_with_gen/README.md
+13 -11
View File
@@ -7,7 +7,7 @@
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* This program is distributed in the hope that it will be useful,
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
@@ -16,30 +16,32 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
-->
# Dart - Component Copy With Gen
# Component Copy With Gen
<p align="left">
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis"><img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" /></a>
<img src="https://img.shields.io/badge/SDK-Dart%20%7C%20Flutter-blue?style=flat-square" alt="SDK: Dart & Flutter" />
</p>
A Dart package for generating code from annotations to ease the use of a UIKit in Flutter applications. The generated code is based on the annotation classes present in the 'wyatt_component_copy_with_extension' package.
A Dart package for generating code from annotations to ease the use of a UIKit in Flutter applications. The generated code is based on the annotation classes present in the [ `wyatt_component_copy_with_extension` package](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_component_copy_with_extension)
> This package does not contain Flutter specific code, but there is no sense in using it without Flutter.
## Features
- Supports the generation of abstract proxies in the `wyatt_ui_components` package.
- Supports direct use in Flutter applications.
* Supports the generation of abstract proxies in the `wyatt_ui_components` package.
* Supports direct use in Flutter applications.
## Usage
### In the 'wyatt_ui_components' package
- Add the appropriate annotation when addicdng a new component.
- Run the build runner command to generate the proxy.
* Add the appropriate annotation when adding a new component.
* Run the build runner command to generate the proxy.
### In Flutter applications
### In Flutter applications (or UI Kit implementations)
- Add the following dependencies to your pubspec.yaml:
* Add the following dependencies to your pubspec.yaml:
```yaml
dependencies:
@@ -51,7 +53,7 @@ dev_dependencies:
build_runner: ^2.3.3
```
- In your UIKit, extend the desired component class and add the appropriate annotation.
- Run the code generation command via the build runner.
* In your UIKit, extend the desired component class and add the appropriate annotation.
* Run the code generation command via the build runner.
For further details and additional features on class annotation, see the 'wyatt_component_copy_with_extension' package's README.
packages/wyatt_component_copy_with_gen/pubspec.yaml
+3 -5
View File
@@ -3,21 +3,19 @@ description: Generator for copywith method for components.
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/component_copy_with_gen
version: 1.0.0
publish_to: "none"
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
environment:
sdk: ">=2.19.0 <3.0.0"
dependencies:
path: ^1.8.0
build: ^2.3.1
source_gen: ^1.2.7
analyzer: ^5.4.0
wyatt_component_copy_with_extension:
git:
url: ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-packages.git
path: packages/wyatt_component_copy_with_extension
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
version: ^1.0.0
dev_dependencies:
test: ^1.21.0