From 051d765d139149a80816d64a7d63cb205e6d1c61 Mon Sep 17 00:00:00 2001 From: "xiaojia22326@163.com" Date: Sun, 13 Jan 2019 21:51:27 +0800 Subject: [PATCH] add some input describe --- lib/widgets/components/Bar/AppBar/index.dart | 2 +- lib/widgets/components/Card/Card/index.dart | 2 +- .../components/Chip/ChipThemeData/index.dart | 2 +- .../components/Dialog/AboutDialog/index.dart | 7 ++++--- .../components/Dialog/AlertDialog/index.dart | 14 +++++--------- lib/widgets/components/Dialog/Dialog/index.dart | 7 ++----- .../components/Dialog/SimpleDialog/index.dart | 3 +++ .../components/Menu/PopupMenuButton/index.dart | 2 +- .../Navigation/BottomNavigationBar/index.dart | 4 ++-- 9 files changed, 20 insertions(+), 23 deletions(-) diff --git a/lib/widgets/components/Bar/AppBar/index.dart b/lib/widgets/components/Bar/AppBar/index.dart index 3b821ee8..eda42fc0 100644 --- a/lib/widgets/components/Bar/AppBar/index.dart +++ b/lib/widgets/components/Bar/AppBar/index.dart @@ -16,7 +16,7 @@ import './demo.dart' as AppBarDemo; const String _Text0 = """### **简介** > AppBar “应用栏” -- 应用栏由工具栏和可能的其他 widget 组成，例如 TabBar和FlexibleSpaceBar; +- 应用栏由工具栏组成，或者是工具栏和其他 widget 组合形成，例如 TabBar和FlexibleSpaceBar; - 应用栏通常用于 Scaffold.appBar 属性，该属性将应用栏放置在屏幕顶部的固定高度小部件中; - 对于可滚动的应用栏，请参阅SliverAppBar，它将AppBar嵌入 sliver 中以便在CustomScrollView中使用; """; diff --git a/lib/widgets/components/Card/Card/index.dart b/lib/widgets/components/Card/Card/index.dart index 45e490fa..0ee2d452 100644 --- a/lib/widgets/components/Card/Card/index.dart +++ b/lib/widgets/components/Card/Card/index.dart @@ -16,7 +16,7 @@ import './demo.dart' as CardDemo; const String _Text0 = """### **简介** > Card “卡片” -- 卡片是用于表示一些相关信息的一张材料，例如相册，地理位置，用餐，联系方式等 +- 卡片用于表示一些相关信息，例如相册，地理位置，用餐，联系方式等 """; diff --git a/lib/widgets/components/Chip/ChipThemeData/index.dart b/lib/widgets/components/Chip/ChipThemeData/index.dart index 11cef164..908b4c6f 100644 --- a/lib/widgets/components/Chip/ChipThemeData/index.dart +++ b/lib/widgets/components/Chip/ChipThemeData/index.dart @@ -17,7 +17,7 @@ const String content0 = ''' const String content1 = ''' ### **基本用法** - 创建ChipThemeData最简单的方法是使用copyWith您从得到一个ChipTheme.of， -或创建一个全新的一个具有 ChipThemeData..fromDefaults。。 +或创建一个全新的一个具有 ChipThemeData..fromDefaults '''; class Demo extends StatefulWidget { diff --git a/lib/widgets/components/Dialog/AboutDialog/index.dart b/lib/widgets/components/Dialog/AboutDialog/index.dart index 47d1bfca..6b88c60c 100644 --- a/lib/widgets/components/Dialog/AboutDialog/index.dart +++ b/lib/widgets/components/Dialog/AboutDialog/index.dart @@ -13,12 +13,13 @@ import 'demo.dart'; const String _Text0 = """ ### **简介** > AboutDialog 通常用于传递企业或者app的官方信息 - +- 这个对话框包含应用程序的图标，名称，版本号，版权和应用程序使用到的软件许可证的按钮 ### **基本用法** - -> 通常作为子窗口小部件传递给showDialog，后者显示对话框。 +> 要显示的AboutDialog，使用showAboutDialog。 +- 如果应用程序具有Drawer，则AboutListTile可以使显示AboutDialog的过程更简单。 +- AboutDialog通过showAboutDialog 显示按钮调用 showLicensePage。 """; diff --git a/lib/widgets/components/Dialog/AlertDialog/index.dart b/lib/widgets/components/Dialog/AlertDialog/index.dart index 4022860c..e9364564 100644 --- a/lib/widgets/components/Dialog/AlertDialog/index.dart +++ b/lib/widgets/components/Dialog/AlertDialog/index.dart @@ -12,18 +12,14 @@ import 'demo.dart'; const String _Text0 = """ ### **简介** -> AlertDialog 向用户传递信息的弹出层。 - - +> AlertDialog 向用户传递信息的弹出层。警报对话框 +- 一般使用在通知用户需要确认的情况，具有可选标题和可选的操纵列表。标题显示在上方，操纵内容显示在内容区域，即下方 ### **基本用法** - > 通常作为子窗口小部件传递给showDialog，后者显示对话框。 - -当**AlertDialog**的的元素过多过长时, 请优先考虑**SingleChildScrollView** 用来避免内容溢出 - - - +- 当**AlertDialog**的的元素过多过长时, 请优先考虑**SingleChildScrollView** 用来避免内容溢出 +- 需要注意的是，由于AlertDialog 通常使用child的大小来调整自身大小，所以使用一些widget（如ListView，GridView和CustomScrollView）将无法正常工作 +- 当需要给用户提供多个选项的供选择时，请使用SimpleDialog """; diff --git a/lib/widgets/components/Dialog/Dialog/index.dart b/lib/widgets/components/Dialog/Dialog/index.dart index 268802f1..626cdc92 100644 --- a/lib/widgets/components/Dialog/Dialog/index.dart +++ b/lib/widgets/components/Dialog/Dialog/index.dart @@ -12,17 +12,14 @@ import 'demo.dart'; const String _Text0 = """ ### **简介** -> AlertDialog 向用户传递信息的弹出层。 - -这个组件没有任何可操作的选项. 相比使用这个组件, 通常我们更喜欢使用 **AlertDialog**或者**SimpleDialog** +> Dialog 向用户传递信息的弹出层。 +-这个组件没有任何可操作的选项. 相比使用这个组件, 通常我们更喜欢使用 **AlertDialog**或者**SimpleDialog** ### **基本用法** - > 通常作为子窗口小部件传递给showDialog，后者显示对话框。 - """; const String _Text1 = """ diff --git a/lib/widgets/components/Dialog/SimpleDialog/index.dart b/lib/widgets/components/Dialog/SimpleDialog/index.dart index 641b9e5a..4f607d73 100644 --- a/lib/widgets/components/Dialog/SimpleDialog/index.dart +++ b/lib/widgets/components/Dialog/SimpleDialog/index.dart @@ -13,12 +13,15 @@ import 'demo.dart'; const String _Text0 = """ ### **简介** > SimpleDialog 是一个用于向用户传递确定信息并提供选项的弹出层 +- SimpleDialog 可为用户提供多个选项选择。有一个可选的标题，显示在选项上方 ### **基本用法** > 通常作为子窗口小部件传递给showDialog，后者显示对话框。 +- 选择通常使用SimpleDialogOption表示 +- 对于通知用户情况的对话框，请考虑使用 AlertDialog。 """; diff --git a/lib/widgets/components/Menu/PopupMenuButton/index.dart b/lib/widgets/components/Menu/PopupMenuButton/index.dart index 61466760..ae6b45e9 100644 --- a/lib/widgets/components/Menu/PopupMenuButton/index.dart +++ b/lib/widgets/components/Menu/PopupMenuButton/index.dart @@ -12,7 +12,7 @@ const String content0 = ''' ### **简介** > 一个提供菜单栏弹出对话框的按钮 - 点击的时候弹出菜单栏对话框，当选择其中一项后会调用 onSelected方法。传递其所选的菜单项的值 -- 可以提供child子widget或者一个icon给它，但是并不能两者都提供 +- 可以提供一个child widget或者提供一个icon给它，但是并不能两者都提供 - 如果什么都没有提供给 PopupMenuButton ，则会根据运行平台创建一个overflow icon '''; diff --git a/lib/widgets/components/Navigation/BottomNavigationBar/index.dart b/lib/widgets/components/Navigation/BottomNavigationBar/index.dart index e38bdfd4..d5241c19 100644 --- a/lib/widgets/components/Navigation/BottomNavigationBar/index.dart +++ b/lib/widgets/components/Navigation/BottomNavigationBar/index.dart @@ -15,7 +15,7 @@ import './demo.dart' as BottomNavigationBarDemo; const String _text0 = """### **简介** -> BottomNavigationBar “底部导航栏”， +> BottomNavigationBar “底部导航栏” - 显示在应用程序底部的导航栏,由文本标签，图标或两者形式的多个项目组成; - 它提供了应用程序顶级视图之间的快速导航; """; @@ -26,7 +26,7 @@ const String _text1 = > BottomNavigationBar 底部导航栏通常与Scaffold结合使用 - 它作为 Scaffold.bottomNavigationBar 参数; - BottomNavigationBar 支持0-4个之间个底部按钮数量，超出4个系统将会报异常; -- 默认0-3个底部按钮数量时，BottomNavigationBar采用fixed的模式摆放底部按钮，当超过4个时默认使用 BottomNavigationBarType.shifting 模式摆放底部按钮; +- 默认0-3个底部按钮数量时，BottomNavigationBar采用fixed的模式摆放底部按钮，当有4个时默认使用 BottomNavigationBarType.shifting 模式摆放底部按钮; - 下面的底部导航即是效果; """;