From 62939be0619447b214f0389ab8531274139b9da8 Mon Sep 17 00:00:00 2001 From: lmy <2534290808@qq.com> Date: Thu, 25 Apr 2019 11:50:09 +0800 Subject: [PATCH] update README --- README.md | 7 +++++++ README_zh-CN.md | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index d6f6016..ef37a09 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,13 @@ Customizable Icons for Flutter,Inspired by [react-native-vector-icons](https://g ## Usage To use this plugin, add `flutter_icons` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). +## Static Methods + +| Prop | Description | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **`getIconData`** | Returns the IconData object,eg : ```IconData iconData = AntDesign.getIconData("stepforward")``` | +| **`hasIconData`** | Checks if the name is valid in current icon set.eg: ```bool isNameValid = AntDesign.hasIconData("stepforward")```| + ## Example ``` dart diff --git a/README_zh-CN.md b/README_zh-CN.md index dab86e0..89982c2 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -26,6 +26,13 @@ ## 使用 要使用此插件包,请将flutter_icons作为依赖项添加到您的`pubspec.yaml`文件中,详见[dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). +## 静态方法 + +| Prop | Description | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **`getIconData`** | 返回IconData对象供Icon使用,eg : ```IconData iconData = AntDesign.getIconData("stepforward")``` | +| **`hasIconData`** | 检查是否存在name对应的IconData对象,返回布尔值,eg: ```bool isNameValid = AntDesign.hasIconData("stepforward")```| + ## 示例 ``` dart