https://github.com/surfstudio/flutter-render-metrics
Made by Surf 🏄
https://github.com/surfstudio/flutter-render-metrics
Last synced: 3 months ago
JSON representation
Made by Surf 🏄
- Host: GitHub
- URL: https://github.com/surfstudio/flutter-render-metrics
- Owner: surfstudio
- License: apache-2.0
- Created: 2021-07-09T05:40:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-24T15:22:49.000Z (over 1 year ago)
- Last Synced: 2025-04-13T07:13:18.603Z (6 months ago)
- Language: Dart
- Homepage:
- Size: 558 KB
- Stars: 20
- Watchers: 5
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Render Metrics
Made by [Surf 🏄♂️🏄♂️🏄♂️](https://surf.dev/)
[](https://github.com/surfstudio/flutter-render-metrics)
[](https://app.codecov.io/gh/surfstudio/flutter-render-metrics)
[](https://pub.dev/packages/render_metrics)
[](https://pub.dev/packages/render_metrics)
[](https://pub.dev/packages/render_metrics/score)
## Overview
This package helps retrieve the current positioning coordinates of any widget in a widgets tree in your Flutter application.
## Currently supported features
- Retrieve the full set of positioning coordinates of the desired widget at any time;
- Calculate the difference in positioning between two widgets and use it the way you need.
## Example
### Getting widget's coordinates
Instantiate `RenderParametersManager` object. You can set a special type for the widget's unique identifier or leave it `dynamic`.
```dart
final renderManager = RenderParametersManager();
```
Wrap the desired widget in a `RenderMetricsObject`. The `id` parameter is the widget’s unique identifier.
```dart
RenderMetricsObject(
id: "uniqueWidgetId",
manager: renderManager,
child: Container(
...
),
),
```
Get a bundle with the positioning coordinates of the wrapped widget.
```dart
RenderData data = renderManager.getRenderData("uniqueWidgetId");
```
### Calculating the difference in positioning between two widgets
Wrap the widgets you want to compare in `RenderMetricsObject`s. Specify two different `id`s for each of them. Please note, that the `manager` parameter of both widgets should contain the link to the same `RenderParametersManager` instance.
```dart
RenderMetricsObject(
id: "rowWidgetId",
manager: renderManager,
child: Row(
...
),
),
RenderMetricsObject(
id: "columnWidgetId",
manager: renderManager,
child: Column(
...
),
),
```
Specify two unique widget identifiers when using the `getDiffById()` function and extract a bundle with the relative difference in positioning coordinates between the widgets.
```dart
ComparisonDiff diff =
renderManager.getDiffById("rowWidgetId", "columnWidgetId");
```
## What metrics can I get?
### RenderData
`RenderData` instance contains a complete set of properties that characterize any widget in a two-dimensional space.
All metrics positioning coordinates are global, meaning they are relative to the entire screen coordinate space.
`RenderData` also provides you an ability to get all widget keypoint XY-coordinates by calling one of special getters.
### ComparisonDiff
You can get the comparison relative results for each widget keypoint from the `ComparisonDiff` instance.
An additional set of special getters can help you calculate the difference between two adjacent sides of two different widgets (e.g. right to left, top to bottom, etc.).
## Installation
Add `render_metrics` to your `pubspec.yaml` file:
```yaml
dependencies:
render_metrics: $currentVersion$
```
At this moment, the current version of render_metrics is 
.
## Changelog
All notable changes to this project will be documented in [this file](./CHANGELOG.md).
## Issues
To report your issues, submit them directly in the [Issues](https://github.com/surfstudio/flutter-render-metrics/issues) section.
## Contribute
If you would like to contribute to the package (e.g. by improving the documentation, fixing a bug or adding a cool new feature), please read our [contribution guide](./CONTRIBUTING.md) first and send us your pull request.
Your PRs are always welcome.
## How to reach us
Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.
[](https://t.me/SurfGear)
## License
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)