migrate docs to null-safety

CHANGELOG.md

@@ -11,6 +11,7 @@
 - Add build test thank to **AlexV525**.
 
 #### components
+- **Breaking change**: remove <code>BrnHorizontalStepsManager</code> and put function <code>forwardStep()</code>  <code>backStep()</code> into <code>BrnStepsController</code>.
 - <code>BrnCalendarView</code>: add <code>BrnCalendarView.single()</code> and <code>BrnCalendarView.range()</code> constructor and had its argument <code>startEndDateChange</code> removed.
 - <code>BrnSelectionEntityListBean</code>: <code>fromMap</code> is renamed to <code>fromJson</code>.
 - <code>BrnRadioButton</code>: optimize click area [#31](https://github.com/LianjiaTech/bruno/pull/31) , thanks to **a1017480401** .

docs/components/bottomButtonPanel/BrnBottomButtonPanel/BrnBottomButtonPanel.md

@@ -45,25 +45,25 @@ group:
 
 ```dart
 const BrnBottomButtonPanel(
-  {Key key,
-  @required this.mainButtonName,
-  @required this.mainButtonOnTap,
-  this.secondaryButtonName,
-  this.secondaryButtonOnTap,
-  this.enableMainButton = true,
-  this.enableSecondaryButton = true,
-  this.iconButtonList})
-  : super(key: key);
+      {Key? key,
+      required this.mainButtonName,
+      required this.mainButtonOnTap,
+      this.secondaryButtonName,
+      this.secondaryButtonOnTap,
+      this.enableMainButton = true,
+      this.enableSecondaryButton = true,
+      this.iconButtonList})
+      : super(key: key);
 ```
 ### 参数说明
 
 | 参数名 | 参数类型 | 描述 | 是否必填 | 默认值 |
 | --- | --- | --- | --- | --- |
-| mainButtonName | String | 主按钮的显示文案 | 否 | '' |
+| mainButtonName | String | 主按钮的显示文案 | 否 | 无 |
 | mainButtonOnTap | VoidCallback | 主按钮的点击回调 | 否 | 无 |
-| secondaryButtnoName | String | 次按钮显示文案 | 否 | '' |
-| secondaryButtonOnTap | VoidCallback | 次按钮的点击回调 | 否 | 无 |
-| iconButtonList | List | icon按钮的集合 | 否 | 无 |
+| secondaryButtonName | String? | 次按钮显示文案 | 否 | 无 |
+| secondaryButtonOnTap | VoidCallback? | 次按钮的点击回调 | 否 | 无 |
+| iconButtonList | List<BrnVerticalIconButton>? | icon按钮的集合 | 否 | 无 |
 | enableMainButton | bool | 主按钮是否可用 | 否 | true |
 | enableSecondaryButton | bool | 次按钮是否可用 | 否 | true |
 

docs/components/bottomButtonPanel/BrnMultipleBottomButton/BrnMultipleBottomButton.md

@@ -27,16 +27,17 @@ group:
 ### 构造函数
 
 ```dart
-BrnMultipleBottomButton(
-  {Key key,
-  this.mainButtonName,
-  this.subButtonName,
-  this.onSelectAllTap,
-  this.onMainButtonTap,
-  this.onSelectedButtonTap,
-  this.onSubButtonTap,
-  this.hasArrow = false,
-  this.bottomController})
+const BrnMultipleBottomButton(
+      {Key? key,
+      this.mainButton,
+      this.subButton,
+      this.onMainButtonTap,
+      this.onSubButtonTap,
+      this.onSelectedButtonTap,
+      this.onSelectAll,
+      this.hasArrow = false,
+      this.bottomController})
+      : super(key: key);
 ```
 
 
@@ -47,13 +48,13 @@ BrnMultipleBottomButton(
 | **参数名** | **参数类型** | **描述** | **是否必填** | **默认值** |
 | --- | --- | --- | --- | --- |
 | mainButton | dynamic | 主按钮的显示文案，传入String即使用默认的Text样式，传入其他样式则使用对应的Widget | 否 |  |
-| onMainButtonTap | VoidCallback | 主按钮点击回调 | 否 |  |
+| onMainButtonTap | VoidCallback? | 主按钮点击回调 | 否 |  |
 | subButton | dynamic | 次按钮的显示文案，传入String即使用默认的Text样式，传入其他样式则使用对应的Widget | 否 |  |
-| onSubButtonTap | VoidCallback | 次按钮点击回调 | 否 |  |
-| onSelectedButtonTap | Function(int) | selectedButtonOnTap', '点击已选的回调，存在三种状态：-1:不可展开（当value为0的时候），0：收起，1：展开 | 否 |  |
-| onSelectAll | Function(bool) | 全选的点击回调，不传则不展示多选按钮，回传参数true表示选中全选，false表示取消全选 | 否 |  |
+| onSubButtonTap | VoidCallback? | 次按钮点击回调 | 否 |  |
+| onSelectedButtonTap | Function(BrnMultipleButtonArrowState)? | selectedButtonOnTap', '点击已选的回调，存在三种状态：-1:不可展开（当value为0的时候），0：收起，1：展开 | 否 |  |
+| onSelectAll | void Function(bool?)? | 全选的点击回调，不传则不展示多选按钮，回传参数true表示选中全选，false表示取消全选 | 否 |  |
 | hasArrow | bool | 已选侧边是否需要小箭头 | 否 | false |
-| bottomController | BrnMultipleBottomController | 暴露给外界设置按钮状态的控制器 | 否 |  |
+| bottomController | BrnMultipleBottomController? | 暴露给外界设置按钮状态的控制器 | 否 |  |
 
 
 

docs/components/buttonPanel/BrnButtonPanel/BrnButtonPanel.md

@@ -33,16 +33,16 @@ group:
 
 ```dart
 const BrnButtonPanel(
-  {Key key,
-  @required this.mainButtonName,
-  @required this.mainButtonOnTap,
-  this.isMainBtnEnable = true,
-  this.secondaryButtonNameList,
-  this.secondaryButtonOnTap,
-  this.secondaryButtonList,
-  this.horizontalPadding = 20,
-  this.popDirection = BrnPopupDirection.bottom})
-  : super(key: key);
+      {Key? key,
+      required this.mainButtonName,
+      required this.mainButtonOnTap,
+      this.isMainBtnEnable = true,
+      this.secondaryButtonNameList,
+      this.secondaryButtonOnTap,
+      this.secondaryButtonList,
+      this.horizontalPadding = 20,
+      this.popDirection = BrnPopupDirection.bottom})
+      : super(key: key);
 ```
 ### 参数说明
 

docs/components/buttonPanel/BrnTextButtonPanel/BrnTextButtonPanel.md

@@ -30,12 +30,12 @@ group:
 ### 构造函数
 
 ```dart
-BrnTextButtonPanel(
-  {Key key,
-  @required this.nameList,
-  this.onTap,
-  this.popDirection = BrnPopupDirection.bottom})
-  : super(key: key);
+const BrnTextButtonPanel({
+    Key? key,
+    required this.nameList,
+    this.onTap,
+    this.popDirection = BrnPopupDirection.bottom,
+  }) : super(key: key);
 ```
 ### 参数说明
 

docs/components/charts/BrnBrokenLine/BrnBrokenLine.md

@@ -30,9 +30,9 @@ group:
 
 ```dart
 BrnBrokenLine({
-    Key key,
-    @required this.size,
-    @required this.lines,
+    Key? key,
+    required this.size,
+    required this.lines,
     this.contentPadding = const EdgeInsets.only(left: 10, right: 10),
     this.backgroundColor,
     this.xyDialLineWidth = 2,
@@ -44,8 +44,8 @@ BrnBrokenLine({
     this.xDialMin,
     this.xDialMax,
     this.xDialValues,
-    this.yDialMin,
-    this.yDialMax,
+    required this.yDialMin,
+    required this.yDialMax,
     this.yDialValues,
     this.isShowXHintLine = true,
     this.isShowYHintLine = false,
@@ -54,36 +54,42 @@ BrnBrokenLine({
     this.isTipWindowAutoDismiss = true,
     this.isShowXDialText = false,
     this.isShowYDialText = false,
-  })
+  }) : super(key: key) {
+    // 设置自定义 X 轴时，检查 x轴的最大、最小刻度范围
+    if (xDialValues != null) {
+      assert(xDialMin != null);
+      assert(xDialMax != null);
+    }
+  }
 ```
 
 ### 参数说明：
 
-| 参数名                 | 参数类型              | 作用                                                                | 是否必填 | 默认值 | 备注 |
-| ---------------------- | --------------------- | ------------------------------------------------------------------- | -------- | ------ | ---- |
-| size                   | Size                  | 表格宽高                                                            | 是       |        |      |
-| lines                  | `List<BrnPointsLine>` | 要绘制的折线集合                                                    | 是       |        |      |
-| contentPadding         | EdgeInsets            | 图标内容区域 padding(不包含坐标轴)                                  | 否       |        |      |
-| backgroundColor        | Color                 | 绘制表格的背景色                                                    | 否       |        |      |
-| xyDialLineWidth        | double                | xy 轴线条的宽度                                                     | 否       | 2      |      |
-| xDialColor             | Color                 | x 轴的颜色                                                          | 否       |        |      |
-| yDialColor             | Color                 | y 轴的颜色                                                          | 否       |        |      |
-| yHintLineOffset        | double                | Y 轴辅助线向右偏移量，默认 20（X 轴刻度线也会跟随该偏移量向右偏移） | 否       | 20     |      |
-| showPointDashLine      | bool                  | 是否展示数据点选中时的辅助线                                        | 否       | true   |      |
-| dialWidth              | double                | Y 轴刻度的宽度，和 X 轴刻度的高度                                   | 否       | 4      |      |
-| xDialMin               | double                | X 轴展示范围最小值                                                  | 否       | 0      |      |
-| xDialMax               | double                | X 轴展示范围最大值                                                  | 否       | 1      |      |
-| yDialMin               | double                | Y 轴展示范围最小值                                                  | 是       | 0      |      |
-| yDialMax               | double                | Y 轴展示范围最大值                                                  | 是       | 1      |      |
-| xDialValues            | `List<BrnDialItem>`   | X 轴刻度数据                                                        | 否       |        |      |
-| yDialValues            | `List<BrnDialItem>`   | Y 轴刻度数据                                                        | 否       |        |      |
-| isShowXHintLine        | bool                  | 是否展示 X 轴辅助线                                                 |          | true   |      |
-| isShowYHintLine        | bool                  | 是否展示 Y 轴辅助线                                                 |          | false  |      |
-| isHintLineSolid        | bool                  | 辅助线是否为虚线                                                    |          | true   |      |
-| hintLineColor          | Color                 | 辅助线颜色                                                          |          |        |      |
-| isTipWindowAutoDismiss | bool                  | 点击弹出的 tip 提示框，是否自动消失                                 |          | true   |      |
-| isShowXDialText        | bool                  | 是否展示 X 坐标刻度文案                                             |          | false  |      |
-| isShowYDialText        | bool                  | 是否展示 Y 坐标刻度文案                                             |          | false  |      |
+| 参数名                 | 参数类型              | 作用                                                         | 是否必填 | 默认值                               | 备注 |
+| ---------------------- | --------------------- | ------------------------------------------------------------ | -------- | ------------------------------------ | ---- |
+| size                   | Size                  | 表格宽高                                                     | 是       |                                      |      |
+| lines                  | `List<BrnPointsLine>` | 要绘制的折线集合                                             | 是       |                                      |      |
+| contentPadding         | EdgeInsets            | 图标内容区域 padding(不包含坐标轴)                           | 否       | EdgeInsets.only(left: 10, right: 10) |      |
+| backgroundColor        | Color？               | 绘制表格的背景色                                             | 否       |                                      |      |
+| xyDialLineWidth        | double                | xy 轴线条的宽度                                              | 否       | 2                                    |      |
+| xDialColor             | Color？               | x 轴的颜色                                                   | 否       |                                      |      |
+| yDialColor             | Color？               | y 轴的颜色                                                   | 否       |                                      |      |
+| yHintLineOffset        | double                | Y 轴辅助线向右偏移量，默认 20（X 轴刻度线也会跟随该偏移量向右偏移） | 否       | 20.0                                 |      |
+| showPointDashLine      | bool                  | 是否展示数据点选中时的辅助线                                 | 否       | true                                 |      |
+| dialWidth              | double                | Y 轴刻度的宽度，和 X 轴刻度的高度                            | 否       | 4                                    |      |
+| xDialMin               | double                | X 轴展示范围最小值                                           | 否       |                                      |      |
+| xDialMax               | double                | X 轴展示范围最大值                                           | 否       |                                      |      |
+| yDialMin               | double                | Y 轴展示范围最小值                                           | 是       |                                      |      |
+| yDialMax               | double                | Y 轴展示范围最大值                                           | 是       |                                      |      |
+| xDialValues            | `List<BrnDialItem>`   | X 轴刻度数据                                                 | 否       |                                      |      |
+| yDialValues            | `List<BrnDialItem>`？ | Y 轴刻度数据                                                 | 否       |                                      |      |
+| isShowXHintLine        | bool                  | 是否展示 X 轴辅助线                                          |          | true                                 |      |
+| isShowYHintLine        | bool                  | 是否展示 Y 轴辅助线                                          |          | false                                |      |
+| isHintLineSolid        | bool                  | 辅助线是否为虚线                                             |          | true                                 |      |
+| hintLineColor          | Color？               | 辅助线颜色                                                   |          |                                      |      |
+| isTipWindowAutoDismiss | bool                  | 点击弹出的 tip 提示框，是否自动消失                          |          | true                                 |      |
+| isShowXDialText        | bool                  | 是否展示 X 坐标刻度文案                                      |          | false                                |      |
+| isShowYDialText        | bool                  | 是否展示 Y 坐标刻度文案                                      |          | false                                |      |
 
 ### 其他数据结构
 
@@ -101,15 +107,14 @@ class BrnPointData {
   Offset offset;
 
   /// 点要展示的内容
-  String pointText;
+  String? pointText;
 
   /// 点展示内容样式
-  TextStyle pointTextStyle;
+  TextStyle? pointTextStyle;
 
   /// 折线节点的点击击事件是否可用
   bool isClickable;
 
-  /// 每个点的点击行为配置数据
   BrnLineTouchData lineTouchData;
 }
 ```
@@ -119,19 +124,16 @@ class BrnPointData {
 ```
 class BrnLineTouchData {
   /// 用于临时存储要展示 tip 内容在坐标的位置
-  double x, y;
+  double? x, y;
 
   /// 要展示 tip 的相对偏移量
   Offset tipOffset;
 
   /// 要展示的 tip 的宽高
   Size tipWindowSize;
 
-  /// 折线节点点击事件是否可用
-  bool enabled;
-
   /// 点击回调，由于返回 展示内容（String 或 Widget）
-  Function() onTouch;
+  Function()? onTouch;
 }
 ```
 
@@ -147,22 +149,22 @@ class BrnPointsLine {
   double lineWidth;
 
   /// Line渐变色，从曲线到x轴从上到下的闭合颜色集
-  List<Color> shaderColors;
+  List<Color>? shaderColors;
 
   /// 曲线或折线的颜色
   Color lineColor;
 
   /// 点外圈的颜色
-  Color pointColor;
+  Color? pointColor;
 
   /// 点的外半径参数
   double pointRadius;
 
   /// 点内圈的颜色
-  Color pointInnerColor;
+  Color? pointInnerColor;
 
   /// 点内圈的半径
-  double pointInnerRadius;
+  double? pointInnerRadius;
 
   /// 是否显示x轴的文字，用来处理多个线条绘制的时候，同一x轴坐标不需要绘制多次，则只需要将多条线中一个标记绘制即可
   bool isShowXDial;
@@ -183,10 +185,10 @@ class BrnPointsLine {
 ```dart
 class BrnDialItem {
   /// 刻度标志内容
-  String dialText;
+  String? dialText;
 
   /// 刻度标志样式
-  TextStyle dialTextStyle;
+  TextStyle? dialTextStyle;
 
   /// x,y 轴刻度值。用于刻度在坐标的真实定位
   double value;

docs/components/charts/BrnDoughnutChart/BrnDoughnutChart.md

@@ -29,37 +29,39 @@ group:
 
 ```dart
 BrnDoughnutChart(
-  {this.width = 0,
-  this.height = 0,
-  this.padding = EdgeInsets.zero,
-  this.ringWidth = 50,
-  this.data,
-  this.fontSize = 12,
-  this.fontColor = Colors.white,
-  this.selectedItem,
-  this.showTitleWhenSelected = false,
-  this.brnDoughnutSelectCallback});
+    {this.width = 0,
+    this.height = 0,
+    this.padding = EdgeInsets.zero,
+    this.ringWidth = 50,
+    required this.data,
+    this.fontSize = 12,
+    this.fontColor = Colors.white,
+    this.selectedItem,
+    this.showTitleWhenSelected = false,
+    this.selectCallback});
 ```
 ### 参数说明
 
 | **参数名** | **参数类型** | **描述** | **是否必填** | **默认值** |
 | --- | --- | --- | --- | --- |
-| width | double | 宽 | 是 | 0 |
-| height | double | 高 | 是 | 0 |
+| width | double | 宽 | 否 | 0 |
+| height | double | 高 | 否 | 0 |
 | padding | EdgeInsetsGeometry | 内边距 | 否 | EdgeInsets.zero |
 | ringWidth | double | 圆环宽度 | 否 | 50 |
 | data | `List<BrnDoughnutDataItem>` | 饼图数据 | 是 |  |
 | fontSize | double | 选中时展示文字大小 | 否 | 12 |
-| fontColor | Color | 选中时展示文字颜色 | 否 |  |
-| selectedItem | BrnDoughnutDataItem | 选中的项目 | 否 |  |
-| selectCallback | BrnDoughnutSelectCallback | 选中项目时候的回掉 | 否 |  |
-| showTitleWhenSelected | bool | 是否仅在选中时展示 title  | 否 |  |
+| fontColor | Color | 选中时展示文字颜色 | 否 | Colors.white |
+| selectedItem | BrnDoughnutDataItem? | 选中的项目 | 否 |  |
+| selectCallback | BrnDoughnutSelectCallback? | 选中项目时候的回掉 | 否 |  |
+| showTitleWhenSelected | bool | 是否仅在选中时展示 title  | 否 | false |
 
 ### 其他数据
 
 
 ```dart
-DoughnutChartLegend({this.legendStyle = BrnDoughnutChartLegendStyle.wrap, this.data});
+DoughnutChartLegend(
+      {this.legendStyle = BrnDoughnutChartLegendStyle.wrap,
+      required this.data});
 ```
 ## 四、代码演示
 
@@ -79,7 +81,7 @@ Column(
       data: dataList,
       selectedItem: selectedItem,
       showTitleWhenSelected: true,
-      selectCallback: (BrnDoughnutDataItem selectedItem) {
+      selectCallback: (BrnDoughnutDataItem? selectedItem) {
         setState(() {
           this.selectedItem = selectedItem;
         });