项目初始化

gaoluyang

3 天以前 92230c9a97dc9ce9df3313d11d26999c04bb6b26

 src/uni_modules/uni-calendar/readme.md

¶Ô±ÈÐÂÎļþ
@@ -0,0 +1,103 @@


## Calendar æ—¥åŽ†
> **组件名：uni-calendar**
> ä»£ç å—： `uCalendar`


日历组件

> **注意事项**
> ä¸ºäº†é¿å…é”™è¯¯ä½¿ç”¨ï¼Œç»™å¤§å®¶å¸¦æ¥ä¸å¥½çš„开发体验，请在使用组件前仔细阅读下面的注意事项，可以帮你避免一些错误。
> - æœ¬ç»„件农历转换使用的js是 [@1900-2100区间内的公历、农历互转](https://github.com/jjonline/calendar.js)  
> - ä»…支持自定义组件模式
> - `date`属性传入的应该是一个 String ï¼Œå¦‚： 2019-06-27 ï¼Œè€Œä¸æ˜¯ new Date()
> - é€šè¿‡ `insert` å±žæ€§æ¥ç¡®å®šå½“前的事件是 @change è¿˜æ˜¯ @confirm ã€‚理应合并为一个事件，但是为了区分模式，现使用两个事件，这里需要注意
> - å¼¹çª—模式下无法阻止后面的元素滚动，如有需要阻止，请在弹窗弹出后，手动设置滚动元素为不可滚动


### å®‰è£…方式

本组件符合[easycom](https://uniapp.dcloud.io/collocation/pages?id=easycom)规范，`HBuilderX 2.5.5`起，只需将本组件导入项目，在页面`template`中即可直接使用，无需在页面中`import`和注册`components`。

如需通过`npm`方式使用`uni-ui`组件，另见文档：[https://ext.dcloud.net.cn/plugin?id=55](https://ext.dcloud.net.cn/plugin?id=55)

### åŸºæœ¬ç”¨æ³•

在 ``template`` ä¸­ä½¿ç”¨ç»„件

```html
<view>
   <uni-calendar 
   :insert="true"
   :lunar="true" 
   :start-date="'2019-3-2'"
   :end-date="'2019-5-20'"
   @change="change"
    />
</view>
```

### é€šè¿‡æ–¹æ³•æ‰“开日历

需要设置 `insert` ä¸º `false`

```html
<view>
   <uni-calendar 
   ref="calendar"
   :insert="false"
   @confirm="confirm"
    />
    <button @click="open">打开日历</button>
</view>
```

```javascript

export default {
   data() {
      return {};
   },
   methods: {
      open(){
         this.$refs.calendar.open();
      },
      confirm(e) {
         console.log(e);
      }
   }
};

```


## API

### Calendar Props

|  å±žæ€§å   |    ç±»åž‹   | é»˜è®¤å€¼| è¯´æ˜Ž                                                                                       |
|       |                                                                                        |
| date      | String   |-      | è‡ªå®šä¹‰å½“前时间，默认为今天                                                                     |
| lunar      | Boolean   | false   | æ˜¾ç¤ºå†œåŽ†                                                                                    |
| startDate   | String   |-      | æ—¥æœŸé€‰æ‹©èŒƒå›´-开始日期                                                                           |
| endDate   | String   |-      | æ—¥æœŸé€‰æ‹©èŒƒå›´-结束日期                                                                           |
| range      | Boolean   | false   | èŒƒå›´é€‰æ‹©                                                                                    |
| insert   | Boolean   | false   | æ’入模式,可选值，ture：插入模式；false：弹窗模式；默认为插入模式                                          |
|clearDate   |Boolean   |true   |弹窗模式是否清空上次选择内容   |
| selected   | Array      |-      | æ‰“点，期待格式[{date: '2019-06-27', info: '签到', data: { custom: '自定义信息', name: '自定义消息头',xxx:xxx... }}]   |
|showMonth   | Boolean   | true   | æ˜¯å¦æ˜¾ç¤ºæœˆä»½ä¸ºèƒŒæ™¯                                                                           |

### Calendar Events

|  äº‹ä»¶å      | è¯´æ˜Ž                        |返回值|
|                         |      |                            |
| open   | å¼¹å‡ºæ—¥åŽ†ç»„件，`insert :false` æ—¶ç”Ÿæ•ˆ|-    |





## ç»„件示例

点击查看：[https://hellouniapp.dcloud.net.cn/pages/extUI/calendar/calendar](https://hellouniapp.dcloud.net.cn/pages/extUI/calendar/calendar)