document of day-click event

wand2016 · Oct 3, 2020 · d75fc10 · d75fc10
1 parent 78963c3
commit d75fc10
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -157,6 +157,22 @@ Boolean to switch to vertical mode. `false` by default.
  <calendar-heatmap :vertical="true" ... />
 ```
 
+### **day-click** - `day-click`
+Function called when a rect is clicked.
+``` html
+ <calendar-heatmap :@day-click="handleDayClick" ... />
+```
+
+The argument type of the listener is as follows:
+
+```typescript
+{
+  date: Date
+  count: number
+  colorIndex: number
+}
+```
+
 ## License
 
 [MIT](http://opensource.org/licenses/MIT)