From 39a76a3154aa0dcf9e34596814c879683ef279af Mon Sep 17 00:00:00 2001 From: zmtzawqlp Date: Thu, 31 Oct 2019 18:45:10 +0800 Subject: [PATCH] format readme --- API.md | 173 ++++++++++++++++++++++++++++----------------------- README.md | 21 +++---- README_en.md | 21 +++---- 3 files changed, 114 insertions(+), 101 deletions(-) diff --git a/API.md b/API.md index 4c2cd88..e5e0185 100644 --- a/API.md +++ b/API.md @@ -1,6 +1,23 @@ ## 主要Api文档 +- [主要Api文档](#%e4%b8%bb%e8%a6%81api%e6%96%87%e6%a1%a3) + - [配置日历的UI](#%e9%85%8d%e7%bd%ae%e6%97%a5%e5%8e%86%e7%9a%84ui) + - [参数说明](#%e5%8f%82%e6%95%b0%e8%af%b4%e6%98%8e) + - [配置Controller](#%e9%85%8d%e7%bd%aecontroller) + - [通用参数说明](#%e9%80%9a%e7%94%a8%e5%8f%82%e6%95%b0%e8%af%b4%e6%98%8e) + - [给controller添加事件监听](#%e7%bb%99controller%e6%b7%bb%e5%8a%a0%e4%ba%8b%e4%bb%b6%e7%9b%91%e5%90%ac) + - [利用controller来控制日历的切换，支持配置动画](#%e5%88%a9%e7%94%a8controller%e6%9d%a5%e6%8e%a7%e5%88%b6%e6%97%a5%e5%8e%86%e7%9a%84%e5%88%87%e6%8d%a2%e6%94%af%e6%8c%81%e9%85%8d%e7%bd%ae%e5%8a%a8%e7%94%bb) + - [利用controller来获取当前日历的状态和数据](#%e5%88%a9%e7%94%a8controller%e6%9d%a5%e8%8e%b7%e5%8f%96%e5%bd%93%e5%89%8d%e6%97%a5%e5%8e%86%e7%9a%84%e7%8a%b6%e6%80%81%e5%92%8c%e6%95%b0%e6%8d%ae) + - [如何自定义UI](#%e5%a6%82%e4%bd%95%e8%87%aa%e5%ae%9a%e4%b9%89ui) + - [自定义WeekBar](#%e8%87%aa%e5%ae%9a%e4%b9%89weekbar) + - [自定义日历Item：](#%e8%87%aa%e5%ae%9a%e4%b9%89%e6%97%a5%e5%8e%86item) + - [根据实际场景，自定义额外的数据extraData](#%e6%a0%b9%e6%8d%ae%e5%ae%9e%e9%99%85%e5%9c%ba%e6%99%af%e8%87%aa%e5%ae%9a%e4%b9%89%e9%a2%9d%e5%a4%96%e7%9a%84%e6%95%b0%e6%8d%aeextradata) + - [实现进度条样式的日历](#%e5%ae%9e%e7%8e%b0%e8%bf%9b%e5%ba%a6%e6%9d%a1%e6%a0%b7%e5%bc%8f%e7%9a%84%e6%97%a5%e5%8e%86) + - [实现自定义各种标记的日历](#%e5%ae%9e%e7%8e%b0%e8%87%aa%e5%ae%9a%e4%b9%89%e5%90%84%e7%a7%8d%e6%a0%87%e8%ae%b0%e7%9a%84%e6%97%a5%e5%8e%86) + - [手动修改自定义的数据](#%e6%89%8b%e5%8a%a8%e4%bf%ae%e6%94%b9%e8%87%aa%e5%ae%9a%e4%b9%89%e7%9a%84%e6%95%b0%e6%8d%ae) + - [DateModel实体类](#datemodel%e5%ae%9e%e4%bd%93%e7%b1%bb) + ### 配置日历的UI 日历UI相关的配置是在CalendarViewWidget的构造函数里面进行配置就行了。 @@ -19,15 +36,15 @@ ``` #### 参数说明 -属性 | 含义 | 默认值 -:-: | :-: | :-: -weekBarItemWidgetBuilder | 创建顶部的weekbar | 默认样式 -dayWidgetBuilder | 创建日历item | 默认样式 -verticalSpacing|日历item之间的竖直方向间距|默认10 -boxDecoration |整体的背景设置|默认为空 -itemSize| 每个item的边长|手机默认是屏幕宽度/7，网页默认屏幕高度/7| -padding|日历的padding |默认为EdgeInsets.zero -margin| 日历的padding|默认为EdgeInsets.zero +| 属性 | 含义 | 默认值 | +| :----------------------: | :------------------------: | :--------------------------------------: | +| weekBarItemWidgetBuilder | 创建顶部的weekbar | 默认样式 | +| dayWidgetBuilder | 创建日历item | 默认样式 | +| verticalSpacing | 日历item之间的竖直方向间距 | 默认10 | +| boxDecoration | 整体的背景设置 | 默认为空 | +| itemSize | 每个item的边长 | 手机默认是屏幕宽度/7，网页默认屏幕高度/7 | +| padding | 日历的padding | 默认为EdgeInsets.zero | +| margin | 日历的padding | 默认为EdgeInsets.zero | @@ -62,60 +79,60 @@ margin| 日历的padding|默认为EdgeInsets.zero #### 通用参数说明 -属性 | 含义 | 默认值 -:-: | :-: | :-: -selectMode | 选择模式,表示单选或者多选 | 默认是单选
static const int MODE_SINGLE_SELECT = 1;
static const int MODE_MULTI_SELECT = 2; -showMode|展示模式| 默认是只展示月视图
static const int MODE_SHOW_ONLY_MONTH=1;//仅支持月视图
static const int MODE_SHOW_ONLY_WEEK=2;//仅支持星期视图
static const int MODE_SHOW_WEEK_AND_MONTH=3;//支持两种视图，先显示周视图
static const int MODE_SHOW_MONTH_AND_WEEK=4;//支持两种视图，先显示月视图 -minYear | 日历显示的最小年份| 1971 -maxYear | 日历显示的最大年份| 2055 -minYearMonth | 日历显示的最小年份的月份| 1 -maxYearMonth | 日历显示的最大年份的月份| 12 -nowYear | 日历显示的当前的年份| -1 -nowMonth | 日历显示的当前的月份| -1 -minSelectYear | 可以选择的最小年份| 1971 -minSelectMonth | 可以选择的最小年份的月份| 1 -minSelectDay | 可以选择的最小月份的日子| 1 -maxSelectYear | 可以选择的最大年份| 2055 -maxSelectMonth | 可以选择的最大年份的月份| 12 -maxSelectDay | 可以选择的最大月份的日子| 30，注意：不能超过对应月份的总天数 -selectedDateList | 被选中的日期,用于多选| 默认为空Set, Set selectedDateList = new Set() -selectDateModel | 当前选择项,用于单选| 默认为空 -maxMultiSelectCount | 多选，最多选多少个| hhh -extraDataMap | 自定义额外的数据| 默认为空Map，Map extraDataMap = new Map() +| 属性 | 含义 | 默认值 | +| :-----------------: | :-----------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| selectMode | 选择模式,表示单选或者多选 | 默认是单选
static const int MODE_SINGLE_SELECT = 1;
static const int MODE_MULTI_SELECT = 2; | +| showMode | 展示模式 | 默认是只展示月视图
static const int MODE_SHOW_ONLY_MONTH=1;//仅支持月视图
static const int MODE_SHOW_ONLY_WEEK=2;//仅支持星期视图
static const int MODE_SHOW_WEEK_AND_MONTH=3;//支持两种视图，先显示周视图
static const int MODE_SHOW_MONTH_AND_WEEK=4;//支持两种视图，先显示月视图 | +| minYear | 日历显示的最小年份 | 1971 | +| maxYear | 日历显示的最大年份 | 2055 | +| minYearMonth | 日历显示的最小年份的月份 | 1 | +| maxYearMonth | 日历显示的最大年份的月份 | 12 | +| nowYear | 日历显示的当前的年份 | -1 | +| nowMonth | 日历显示的当前的月份 | -1 | +| minSelectYear | 可以选择的最小年份 | 1971 | +| minSelectMonth | 可以选择的最小年份的月份 | 1 | +| minSelectDay | 可以选择的最小月份的日子 | 1 | +| maxSelectYear | 可以选择的最大年份 | 2055 | +| maxSelectMonth | 可以选择的最大年份的月份 | 12 | +| maxSelectDay | 可以选择的最大月份的日子 | 30，注意：不能超过对应月份的总天数 | +| selectedDateList | 被选中的日期,用于多选 | 默认为空Set, Set selectedDateList = new Set() | +| selectDateModel | 当前选择项,用于单选 | 默认为空 | +| maxMultiSelectCount | 多选，最多选多少个 | hhh | +| extraDataMap | 自定义额外的数据 | 默认为空Map，Map extraDataMap = new Map() | #### 给controller添加事件监听 -方法 | 含义 | 默认值 -:-: | :-: | :-: -void addMonthChangeListener(OnMonthChange listener) | 月份切换事件 | -void addOnCalendarSelectListener(OnCalendarSelect listener) | 点击选择事件 | -void addOnMultiSelectOutOfRangeListener(OnMultiSelectOutOfRange listener) | 多选超出指定范围 | -void addOnMultiSelectOutOfSizeListener(OnMultiSelectOutOfSize listener) | 多选超出限制个数 | -void addExpandChangeListener(ValueChanged expandChange)|监听日历的展开收缩状态| +| 方法 | 含义 | 默认值 | +| :-----------------------------------------------------------------------: | :--------------------: | :----: | +| void addMonthChangeListener(OnMonthChange listener) | 月份切换事件 | +| void addOnCalendarSelectListener(OnCalendarSelect listener) | 点击选择事件 | +| void addOnMultiSelectOutOfRangeListener(OnMultiSelectOutOfRange listener) | 多选超出指定范围 | +| void addOnMultiSelectOutOfSizeListener(OnMultiSelectOutOfSize listener) | 多选超出限制个数 | +| void addExpandChangeListener(ValueChanged expandChange) | 监听日历的展开收缩状态 | #### 利用controller来控制日历的切换，支持配置动画 -方法 | 含义 | 默认值 -:-: | :-: | :-: -Future previousPage()|滑动到上一个页面，会自动根据当前的展开状态，滑动到上一个月或者上一个星期。如果已经在第一个页面，没有上一个页面，就会返回false，其他情况返回true| -Future nextPage()|滑动到下一个页面，会自动根据当前的展开状态，滑动到下一个月或者下一个星期。如果已经在最后一个页面，没有下一个页面，就会返回false，其他情况返回true| -void moveToCalendar(int year, int month, int day, {bool needAnimation = false,Duration duration = const Duration(milliseconds: 500),Curve curve = Curves.ease}) | 到指定日期 | -void moveToNextYear()|切换到下一年| -void moveToPreviousYear()|切换到上一年| -void moveToNextMonth()|切换到下一个月份| -void moveToPreviousMonth()|切换到上一个月份| -void toggleExpandStatus()|切换展开状态| -void changeExtraData(Map newMap)|修改自定义的额外数据并刷新日历| +| 方法 | 含义 | 默认值 | +| :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------: | :----: | +| Future previousPage() | 滑动到上一个页面，会自动根据当前的展开状态，滑动到上一个月或者上一个星期。如果已经在第一个页面，没有上一个页面，就会返回false，其他情况返回true | +| Future nextPage() | 滑动到下一个页面，会自动根据当前的展开状态，滑动到下一个月或者下一个星期。如果已经在最后一个页面，没有下一个页面，就会返回false，其他情况返回true | +| void moveToCalendar(int year, int month, int day, {bool needAnimation = false,Duration duration = const Duration(milliseconds: 500),Curve curve = Curves.ease}) | 到指定日期 | +| void moveToNextYear() | 切换到下一年 | +| void moveToPreviousYear() | 切换到上一年 | +| void moveToNextMonth() | 切换到下一个月份 | +| void moveToPreviousMonth() | 切换到上一个月份 | +| void toggleExpandStatus() | 切换展开状态 | +| void changeExtraData(Map newMap) | 修改自定义的额外数据并刷新日历 | #### 利用controller来获取当前日历的状态和数据 -方法 | 含义 | 默认值 -:-: | :-: | :-: -DateTime getCurrentMonth()|获取当前的月份| -Set getMultiSelectCalendar()|获取被选中的日期,多选| -DateModel getSingleSelectCalendar()|获取被选中的日期，单选| +| 方法 | 含义 | 默认值 | +| :-------------------------------------: | :--------------------: | :----: | +| DateTime getCurrentMonth() | 获取当前的月份 | +| Set getMultiSelectCalendar() | 获取被选中的日期,多选 | +| DateModel getSingleSelectCalendar() | 获取被选中的日期，单选 | @@ -290,29 +307,29 @@ class DefaultCustomDayWidget extends BaseCustomDayWidget { ### DateModel实体类 日历所用的日期的实体类DateModel，有下面这些属性。可以在自定义绘制DayWidget的时候，根据相应的属性，进行判断后，绘制相应的UI。 -属性|含义|类型|默认值 -:-: | :-: | :-: |:-: -year|年份|int| -month|月份|int| -day|日期|int|默认为1 -lunarYear|农历年份|int| -lunarMonth|农历月份|int| -lunarDay|农历日期|int| -lunarString|农历字符串|String| -solarTerm|24节气|String| -gregorianFestival|gregorianFestival|String| -traditionFestival|传统农历节日|String| -isCurrentDay|是否是今天|bool|false -isLeapYear|是否是闰年|bool|false -isWeekend|是否是周末|bool|false -isInRange|是否在范围内,比如可以实现在某个范围外，设置置灰的功能|bool|false -isSelected|是否被选中，用来实现一些标记或者选择功能|bool|false -extraData|自定义的额外数据|Object|默认为空 -isCurrentMonth|是否是当前月份|bool| - - -方法|含义| -:-: | :-: | -DateTime getDateTime()|将DateModel转化成DateTime -DateModel fromDateTime(DateTime dateTime)|根据DateTime创建对应的model，并初始化农历和传统节日等信息 -bool operator ==(Object other)|重写==方法，可以判断两个dateModel是否是同一天 \ No newline at end of file +| 属性 | 含义 | 类型 | 默认值 | +| :---------------: | :---------------------------------------------------: | :----: | :------: | +| year | 年份 | int | +| month | 月份 | int | +| day | 日期 | int | 默认为1 | +| lunarYear | 农历年份 | int | +| lunarMonth | 农历月份 | int | +| lunarDay | 农历日期 | int | +| lunarString | 农历字符串 | String | +| solarTerm | 24节气 | String | +| gregorianFestival | gregorianFestival | String | +| traditionFestival | 传统农历节日 | String | +| isCurrentDay | 是否是今天 | bool | false | +| isLeapYear | 是否是闰年 | bool | false | +| isWeekend | 是否是周末 | bool | false | +| isInRange | 是否在范围内,比如可以实现在某个范围外，设置置灰的功能 | bool | false | +| isSelected | 是否被选中，用来实现一些标记或者选择功能 | bool | false | +| extraData | 自定义的额外数据 | Object | 默认为空 | +| isCurrentMonth | 是否是当前月份 | bool | + + +| 方法 | 含义 | +| :---------------------------------------: | :-------------------------------------------------------: | +| DateTime getDateTime() | 将DateModel转化成DateTime | +| DateModel fromDateTime(DateTime dateTime) | 根据DateTime创建对应的model，并初始化农历和传统节日等信息 | +| bool operator ==(Object other) | 重写==方法，可以判断两个dateModel是否是同一天 | \ No newline at end of file diff --git a/README.md b/README.md index c5c2bbc..522de37 100644 --- a/README.md +++ b/README.md @@ -3,17 +3,16 @@ Flutter上的一个日历控件，可以定制成自己想要的样子。 -### Language: [English](https://github.com/fluttercandies/flutter_custom_calendar/blob/master/README_en.md)|中文简体 - -* 概述 -* 在线Demo -* 效果图 -* 快速使用 -* 2.0版本 -* 注意事项 -* 主要Api文档 - - +Language: [English](README_en.md)|中文简体 + +- [FlutterCalendarWidget](#fluttercalendarwidget) + - [概述](#%e6%a6%82%e8%bf%b0) + - [在线Demo](#%e5%9c%a8%e7%ba%bfdemo) + - [效果图](#%e6%95%88%e6%9e%9c%e5%9b%be) +- [使用](#%e4%bd%bf%e7%94%a8) +- [2.0版本](#20%e7%89%88%e6%9c%ac) +- [注意事项](#%e6%b3%a8%e6%84%8f%e4%ba%8b%e9%a1%b9) +- [主要API文档](#%e4%b8%bb%e8%a6%81api%e6%96%87%e6%a1%a3) ### 概述 diff --git a/README_en.md b/README_en.md index 11b4324..e6ffc60 100644 --- a/README_en.md +++ b/README_en.md @@ -1,21 +1,18 @@ ## FlutterCalendarWidget -Flutter上的一个日历控件，可以定制成自己想要的样子。 A calendar widget in flutter,you can design what you want to show! +Language:English|[中文简体](README.md) -### Language:English|[中文简体](https://github.com/fluttercandies/flutter_custom_calendar/blob/master/README.md) - -* Overview -* Online Demo -* Example -* Getting Started -* 2.0 version -* matters needing attention -* API Documentation - - +- [FlutterCalendarWidget](#fluttercalendarwidget) + - [Overview](#overview) + - [Online Demo](#online-demo) + - [Example](#example) +- [Getting Started](#getting-started) +- [2.0 version](#20-version) +- [matters needing attention](#matters-needing-attention) +- [API Documentation](#api-documentation) ### Overview