Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
2534290808 committed Apr 25, 2019
1 parent ee90318 commit 62939be
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions README_zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 62939be

Please sign in to comment.