arnemolland / figma

Figma API client written in pure Dart

figma

A library for interacting with Figma APIs with typed responses and data structures.

Usage

A simple usage example:

import 'package:figma/figma.dart';

main() {
  final file = FigmaClient('token').getFile('key');
}

More intricate and detail usage can be found in the examples.

Features and bugs

Please file feature requests and bugs at the issue tracker.

figma's Issues

Better documentation

Right now, there's limited documentation, no guides and no proper examples. At the very least, the library should;

• Include good documentation for the entire public API surface
• Include "getting started" guide as well as guides for common use-cases
• Include example application(s)

Don't subclass `Error` for `FigmaError`

Thanks for the great package. I think I found a little problem that should be a quick fix.

All subclasses of Error are not meant to be caught. Errors are supposed to model irrecoverable failures in the program.
https://dart.dev/language/error-handling

I would argue that errors in an API request are meant to be caught, so FigmaError should subclass Exception instead. The way it is right now means I have to ignore the avoid_catching_errors lint all the time :)

Missing `textAutoResize` property on `TypeStyle`

The property textAutoResize seems to be missing on TypeStyle.

Missing `layoutGrow` property

There's an error in the Figma documentation about layoutGrow property that is documented only on Vector nodes, but which should also be present on Frame nodes since it indicates how auto-layout's children should behave.

By trying to implement auto-layout rendering, I'm quite confident that it is an issue with Figma documentation since this property is returned by the API for all auto-layout children.

Missing `componentSets ` property on `FileResponse`, and `Component` node

Missing componentSets property on FileResponse.

There's also a dedicated node with COMPONENT_SET type (which is just like a regular components, but identifies variants).

Null safety

It would be great if the package could be migrated null safety, I will provide a pull request

Does not work with Flutter web

This package doesn't work with Flutter web due to its dependency on SecureSocket which isn't available yet for web. I'm curious why HttpClient isn't used instead?