Flutter设计资源同步插件flutter_zeplin的使用

发布于 1周前 作者 wuwangju 来自 Flutter

Flutter设计资源同步插件flutter_zeplin的使用

🎯 使用方法

var zeplinData = ZeplinFlutter.fetchFromZeplin(token: @token, projectId: @projectId);
zeplinData.getColor(@COLORNAME); // Color
zeplinData.getTextStyle(@STYLENAME); // TextStyle
zeplinData.boxSpace(@SPACERNAME); // SizedBox
zeplinData.horizontalSpace(@SPACERNAME); // SizedBox
zeplinData.verticalSpace(@SPACERNAME); // SizedBox

--- OR ---

await ZeplinFlutter.fetchFromZeplin(token: @token, projectId: @projectId);

ZeplinFlutter.instance.getColor(@COLORNAME); // Color
ZeplinFlutter.instance.getTextStyle(@STYLENAME); // TextStyle
ZeplinFlutter.instance.boxSpace(@SPACERNAME); // SizedBox
ZeplinFlutter.instance.horizontalSpace(@SPACERNAME); // SizedBox
ZeplinFlutter.instance.verticalSpace(@SPACERNAME); // SizedBox

💻 示例代码

import 'package:example/datas.dart';
import 'package:flutter/material.dart';
import 'package:flutter_zeplin/flutter_zeplin.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Zeplin Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      debugShowCheckedModeBanner: false,
      home: const MyHomePage(title: 'Zeplin Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;
  late ZeplinFlutter zeplinData;
  late String colorName;
  var loading = true;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  void initState() {
    super.initState();
    ZeplinFlutter.fetchFromZeplin(token: token, projectId: projectId).then((value) {
      setState(() {
        loading = false;
        zeplinData = value;
        colorName = zeplinData.colors.entries.first.key;
      });
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    if (loading) {
      return const Center(child: CircularProgressIndicator());
    } else {
      return Scaffold(
        appBar: AppBar(
          title: Text(widget.title),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text(
                'You have pushed the button this many times:',
                style: zeplinData.getTextStyle('Text Style'),
              ),
              zeplinData.verticalSpace('spacing-xs'),
              Text(
                '$_counter',
                style: Theme.of(context).textTheme.headline4,
              ),
              zeplinData.verticalSpace('spacing-xs'),
              Expanded(
                child: ListView.builder(
                  itemCount: zeplinData.colors.entries.length,
                  itemBuilder: (context, index) {
                    var item = zeplinData.colors.entries.elementAt(index);
                    return ListTile(
                      onTap: () => setState(() => colorName = item.key),
                      title: Text(item.key),
                      subtitle: Text(item.value.toString()),
                      leading: CircleAvatar(
                        backgroundColor: item.value,
                      ),
                    );
                  },
                ),
              )
            ],
          ),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: _incrementCounter,
          tooltip: 'Increment',
          backgroundColor: zeplinData.getColor(colorName),
          child: const Icon(Icons.add),
        ),
      );
    }
  }
}

更多关于Flutter设计资源同步插件flutter_zeplin的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter设计资源同步插件flutter_zeplin的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,关于flutter_zeplin插件的使用,这里是一个基本的代码案例展示,帮助你理解如何在Flutter项目中集成和使用这个插件来同步Zeplin设计资源。

安装flutter_zeplin插件

首先,你需要在你的pubspec.yaml文件中添加flutter_zeplin依赖:

dependencies:
  flutter:
    sdk: flutter
  flutter_zeplin: ^最新版本号  # 请替换为实际可用的最新版本号

然后运行flutter pub get来安装依赖。

初始化插件并获取设计资源

接下来,你需要在你的Flutter应用中初始化flutter_zeplin插件,并调用API来获取Zeplin中的设计资源。

import 'package:flutter/material.dart';
import 'package:flutter_zeplin/flutter_zeplin.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  ZeplinClient? _zeplinClient;
  List<Project>? _projects;

  @override
  void initState() {
    super.initState();
    // 初始化Zeplin客户端
    _zeplinClient = ZeplinClient(
      token: '你的Zeplin API Token',  // 请替换为你的Zeplin API Token
    );

    // 获取项目列表
    _fetchProjects();
  }

  Future<void> _fetchProjects() async {
    try {
      final projects = await _zeplinClient!.getProjects();
      setState(() {
        _projects = projects;
      });
    } catch (e) {
      print('Error fetching projects: $e');
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Zeplin Example'),
        ),
        body: _projects == null
            ? Center(child: CircularProgressIndicator())
            : ListView.builder(
                itemCount: _projects!.length,
                itemBuilder: (context, index) {
                  final project = _projects![index];
                  return ListTile(
                    title: Text(project.name!),
                    subtitle: Text(project.id!.toString()),
                  );
                },
              ),
      ),
    );
  }
}

注意事项

  1. API Token:确保你已经在Zeplin中获取了一个API Token,并替换代码中的你的Zeplin API Token
  2. 权限:确保你的Zeplin账户有足够的权限来访问API并获取所需的数据。
  3. 错误处理:在生产环境中,你需要更健壮的错误处理机制来应对可能的网络问题或API限制。
  4. API速率限制:Zeplin API可能有速率限制,确保你的应用不会频繁发送请求而导致被封禁。

插件功能扩展

flutter_zeplin插件可能还提供了更多功能,比如获取屏幕截图、颜色代码、字体信息等。你可以查阅插件的官方文档或源代码来了解这些功能的具体用法。

以上代码仅展示了如何初始化插件并获取项目列表,实际应用中你可能需要根据具体需求进行更多的API调用和数据展示。

回到顶部