flet-rive 0.1.0__tar.gz → 0.70.0.dev6619__tar.gz

{flet_rive-0.1.0/src/flutter/flet_rive → flet_rive-0.70.0.dev6619}/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

flet_rive-0.70.0.dev6619/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: flet-rive
+Version: 0.70.0.dev6619
+Summary: Display Rive animations in Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://docs.flet.dev/rive
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-rive
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==0.70.0.dev6619
+Dynamic: license-file
+
+# flet-rive
+
+[![pypi](https://img.shields.io/pypi/v/flet-rive.svg)](https://pypi.python.org/pypi/flet-rive)
+[![downloads](https://static.pepy.tech/badge/flet-rive/month)](https://pepy.tech/project/flet-rive)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-rive/LICENSE)
+
+A cross-platform [Flet](https://flet.dev) extension for displaying [Rive](https://rive.app/) animations.
+
+It is based on the [rive](https://pub.dev/packages/rive) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/rive/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
+
+## Usage
+
+### Installation
+
+To install the `flet-rive` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-rive
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-rive
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/rive).

flet_rive-0.70.0.dev6619/README.md

@@ -0,0 +1,40 @@
+# flet-rive
+
+[![pypi](https://img.shields.io/pypi/v/flet-rive.svg)](https://pypi.python.org/pypi/flet-rive)
+[![downloads](https://static.pepy.tech/badge/flet-rive/month)](https://pepy.tech/project/flet-rive)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-rive/LICENSE)
+
+A cross-platform [Flet](https://flet.dev) extension for displaying [Rive](https://rive.app/) animations.
+
+It is based on the [rive](https://pub.dev/packages/rive) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/rive/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
+
+## Usage
+
+### Installation
+
+To install the `flet-rive` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-rive
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-rive
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/rive).

flet_rive-0.70.0.dev6619/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "flet-rive"
+version = "0.70.0.dev6619"
+description = "Display Rive animations in Flet apps."
+readme = "README.md"
+authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "flet==0.70.0.dev6619",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://docs.flet.dev/rive"
+Repository = "https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-rive"
+Issues = "https://github.com/flet-dev/flet/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_rive" = ["**/*"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_rive-0.70.0.dev6619/src/flet_rive/__init__.py

@@ -0,0 +1,3 @@
+from flet_rive.rive import Rive as Rive
+
+__all__ = ["Rive"]

flet_rive-0.70.0.dev6619/src/flet_rive/rive.py

@@ -0,0 +1,82 @@
+from dataclasses import field
+from typing import Optional
+
+import flet as ft
+
+__all__ = ["Rive"]
+
+
+@ft.control("Rive")
+class Rive(ft.LayoutControl):
+    """
+    Displays rive animations.
+    """
+
+    src: str
+    """
+    The source of your rive animation.
+
+    Can either be a URL or a path to a local asset file.
+    """
+
+    placeholder: Optional[ft.Control] = None
+    """
+    Control displayed while the Rive is loading.
+    """
+
+    artboard: Optional[str] = None
+    """
+    The name of the artboard to use.
+    If not specified, the default artboard of the provided `src` is used.
+    """
+
+    alignment: Optional[ft.Alignment] = None
+    """
+    Alignment for the animation in the Rive control.
+    """
+
+    enable_antialiasing: bool = True
+    """
+    Whether to enable anti-aliasing when rendering.
+    """
+
+    use_artboard_size: bool = False
+    """
+    Determines whether to use the inherent size of the artboard,
+    i.e. the absolute size defined by the artboard,
+    or size the control based on the available constraints only (sized by parent).
+    """
+
+    fit: Optional[ft.BoxFit] = None
+    """
+    The animation's fit.
+    """
+
+    speed_multiplier: ft.Number = 1.0
+    """
+    A multiplier for controlling the speed of the Rive animation playback.
+    """
+
+    animations: list[str] = field(default_factory=list)
+    """
+    List of animations to play; default animation is played if empty.
+    """
+
+    state_machines: list[str] = field(default_factory=list)
+    """
+    List of state machines to play; none will play if empty.
+    """
+
+    headers: Optional[dict[str, str]] = None
+    """
+    Headers for network requests.
+    """
+
+    clip_rect: Optional[ft.Rect] = None
+    """
+    Clip the artboard to this rect.
+
+    If not supplied it'll default to the constraint size provided by the parent
+    control.
+    Unless the Artboard has clipping disabled, then no clip will be applied.
+    """

flet_rive-0.70.0.dev6619/src/flet_rive.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: flet-rive
+Version: 0.70.0.dev6619
+Summary: Display Rive animations in Flet apps.
+Author-email: Flet contributors <hello@flet.dev>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://docs.flet.dev/rive
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-rive
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: flet==0.70.0.dev6619
+Dynamic: license-file
+
+# flet-rive
+
+[![pypi](https://img.shields.io/pypi/v/flet-rive.svg)](https://pypi.python.org/pypi/flet-rive)
+[![downloads](https://static.pepy.tech/badge/flet-rive/month)](https://pepy.tech/project/flet-rive)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-rive/LICENSE)
+
+A cross-platform [Flet](https://flet.dev) extension for displaying [Rive](https://rive.app/) animations.
+
+It is based on the [rive](https://pub.dev/packages/rive) Flutter package.
+
+## Documentation
+
+Detailed documentation to this package can be found [here](https://docs.flet.dev/rive/).
+
+## Platform Support
+
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
+
+## Usage
+
+### Installation
+
+To install the `flet-rive` package and add it to your project dependencies:
+
+- Using `uv`:
+    ```bash
+    uv add flet-rive
+    ```
+
+- Using `pip`:
+    ```bash
+    pip install flet-rive
+    ```
+    After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
+
+### Examples
+
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/rive).

{flet_rive-0.1.0 → flet_rive-0.70.0.dev6619}/src/flet_rive.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 src/flet_rive/__init__.py
@@ -7,12 +8,9 @@ src/flet_rive.egg-info/SOURCES.txt
 src/flet_rive.egg-info/dependency_links.txt
 src/flet_rive.egg-info/requires.txt
 src/flet_rive.egg-info/top_level.txt
-src/flutter/flet_rive/CHANGELOG.md
-src/flutter/flet_rive/LICENSE
-src/flutter/flet_rive/README.md
 src/flutter/flet_rive/analysis_options.yaml
 src/flutter/flet_rive/pubspec.lock
 src/flutter/flet_rive/pubspec.yaml
 src/flutter/flet_rive/lib/flet_rive.dart
-src/flutter/flet_rive/lib/src/create_control.dart
+src/flutter/flet_rive/lib/src/extension.dart
 src/flutter/flet_rive/lib/src/rive.dart

flet_rive-0.70.0.dev6619/src/flet_rive.egg-info/requires.txt

@@ -0,0 +1 @@
+flet==0.70.0.dev6619

flet_rive-0.70.0.dev6619/src/flutter/flet_rive/lib/flet_rive.dart

@@ -0,0 +1,3 @@
+library flet_rive;
+
+export "src/extension.dart" show Extension;

flet_rive-0.70.0.dev6619/src/flutter/flet_rive/lib/src/extension.dart

@@ -0,0 +1,16 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/cupertino.dart';
+
+import 'rive.dart';
+
+class Extension extends FletExtension {
+  @override
+  Widget? createWidget(Key? key, Control control) {
+    switch (control.type) {
+      case "Rive":
+        return RiveControl(control: control);
+      default:
+        return null;
+    }
+  }
+}

flet_rive-0.70.0.dev6619/src/flutter/flet_rive/lib/src/rive.dart

@@ -0,0 +1,75 @@
+import 'package:flet/flet.dart';
+import 'package:flutter/widgets.dart';
+import 'package:rive/rive.dart';
+
+class RiveControl extends StatefulWidget {
+  final Control control;
+
+  const RiveControl({super.key, required this.control});
+
+  @override
+  State<RiveControl> createState() => _RiveControlState();
+}
+
+class _RiveControlState extends State<RiveControl> {
+  @override
+  Widget build(BuildContext context) {
+    debugPrint("Rive build: ${widget.control.id} (${widget.control.hashCode})");
+    var src = widget.control.getString("src");
+    if (src == null) {
+      return const ErrorControl("Rive must have \"src\" specified.");
+    }
+
+    var artBoard = widget.control.getString("art_board");
+    var antiAliasing = widget.control.getBool("enable_anti_aliasing", true)!;
+    var useArtBoardSize = widget.control.getBool("use_art_board_size", false)!;
+    var fit = widget.control.getBoxFit("fit");
+    var alignment = widget.control.getAlignment("alignment");
+    var placeholder = widget.control.buildWidget("placeholder");
+    var speedMultiplier = widget.control.getDouble("speed_multiplier", 1)!;
+    var animations = widget.control.get<List<String>>("animations", const [])!;
+    var stateMachines =
+        widget.control.get<List<String>>("state_machines", const [])!;
+    var headers = widget.control.get("headers")?.cast<String, String>();
+    var clipRect = widget.control.getRect("clip_rect");
+
+    Widget? rive;
+
+    var assetSrc = widget.control.backend.getAssetSource(src);
+    if (assetSrc.isFile) {
+      // Local File
+      rive = RiveAnimation.file(
+        assetSrc.path,
+        artboard: artBoard,
+        fit: fit,
+        antialiasing: antiAliasing,
+        useArtboardSize: useArtBoardSize,
+        alignment: alignment,
+        placeHolder: placeholder,
+        speedMultiplier: speedMultiplier,
+        animations: animations,
+        stateMachines: stateMachines,
+        clipRect: clipRect,
+      );
+    } else {
+      // URL
+      rive = RiveAnimation.network(
+        assetSrc.path,
+        fit: fit,
+        artboard: artBoard,
+        alignment: alignment,
+        antialiasing: antiAliasing,
+        useArtboardSize: useArtBoardSize,
+        placeHolder: placeholder,
+        speedMultiplier: speedMultiplier,
+        animations: animations,
+        stateMachines: stateMachines,
+        headers: headers,
+        clipRect: clipRect,
+        // onInit: _onInit,
+      );
+    }
+
+    return ConstrainedControl(control: widget.control, child: rive);
+  }
+}