gtht-miniapp-sdk/components/calendar-input/README.md

gtht-miniapp-sdk 是一套基于 Uniapp + Vue3 框架开发的兼容多端的 UI 组件库

---
nav: 组件
title: CalendarInput
subtitle: 日历输入框
group: 表单组件
---

## 介绍

组合了日历、弹出框、输入框组件，实现了便捷快速的日历选择功能。

## 引入

```ts
import CalendarInput from 'gtht-miniapp-sdk/components/calendar-input/calendar-input.vue'
```

## 代码演示

### 基础使用

使用 `v-model` 绑定当前值，通过 `title` 和 `placeholder` 属性设置弹出框标题和输入框占位文本。

在点击输入框后会显示日历弹出框。

@code('${DEMO_PATH}/calendar-input/demo/Basic.vue')

### 输入框日期格式

使用 `outlet-format` 属性自定义输入框日期展示的格式。

@code('${DEMO_PATH}/calendar-input/demo/OutletFormat.vue')

### 绑定值的格式

默认绑定的值为 `Date` 实例，提交到后端时需要手动转换为特定格式的字符串；使用 `value-format` 属性可以将这个转换交由组件库处理。

@code('${DEMO_PATH}/calendar-input/demo/ValueFormat.vue')

### 类型

下面展示了不同类型选择的值在输入框的展示。

@code('${DEMO_PATH}/calendar-input/demo/Type.vue')

## API

### CalendarInputProps

继承 [`CalendarPopoutProps`](./calendar-popout#CalendarPopoutProps) 并有以下额外属性：

| 属性                              | 描述                   | 类型                                                      | 默认值          |
| --------------------------------- | ---------------------- | --------------------------------------------------------- | --------------- |
| root-class                        | 弹出式输入框根元素类名 | string                                                    | -               |
| root-style                        | 弹出式输入框根元素样式 | StyleValue                                                | -               |
| disabled                          | 禁用状态               | boolean                                                   | false           |
| readonly                          | 只读状态               | boolean                                                   | false           |
| clearable                         | 是否显示清空按钮       | boolean                                                   | false           |
| placeholder                       | 输入框占位符内容       | string                                                    | -               |
| outlet-format <sup>1.10+</sup>    | 输出到输入框的日期格式 | string [详见特殊符号](../utilities/date#日期格式特殊符号) | 'YYYY-MM-DD'    |
| value-on-clear <sup>1.19.2+</sup> | 设置点击清除按钮后的值 | () => any                                                 | () => undefined |
| arrow <sup>1.22+</sup>            | 自定义箭头图标名       | string                                                    | 'caret-right'   |
| arrow-family <sup>1.22+</sup>     | 自定义箭头图标字体     | string                                                    | 'sari'          |
| input-props <sup>1.22+</sup>      | 自定义输入框组件属性   | InputProps                                                | -               |

### CalendarInputSlots

| 插槽                   | 描述       | 属性       |
| ---------------------- | ---------- | ---------- |
| arrow <sup>1.22+</sup> | 自定义箭头 | () => void |

### CalendarInputEmits

继承 [`CalendarPopoutEmits`](./calendar-popout#CalendarPopoutEmits)