Skip to content

Commit 08b5093

Browse files
committed
docs(calendar): update readme files #4282
1 parent 8f9980c commit 08b5093

File tree

2 files changed

+24
-2
lines changed

2 files changed

+24
-2
lines changed

projects/igniteui-angular/src/lib/calendar/README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@ A multiple selection calendar with different locale and templating for the subhe
5555
</igx-calendar>
5656
```
5757

58+
A calendar displaying more than one month in the view and hiding the days that are outside of the current month
59+
```html
60+
<igx-calendar monthsViewNumber="2" [hideOutsideDays]="'true'">
61+
</igx-calendar>
62+
```
63+
5864
The **igxCalendar** implements the `ControlValueAccessor` interface, providing two-way data-binding
5965
and the expected behavior when used both in Template-driven or Reactive Forms.
6066

@@ -65,8 +71,8 @@ When the **igxCalendar** component is focused:
6571
- `PageDown` will move to the next month.
6672
- `Shift + PageUp` will move to the previous year.
6773
- `Shift + PageDown` will move to the next year.
68-
- `Home` will focus the first day of the current month that is into view.
69-
- `End` will focus the last day of the current month that is into view.
74+
- `Home` will focus the first day of the current month (or first month if more months are displayed) hat is into view.
75+
- `End` will focus the last day of the current month ((or last month if more months are displayed)) that is into view.
7076
- `Tab` will navigate through the subheader buttons;
7177

7278
When `prev` or `next` month buttons (in the subheader) are focused:
@@ -82,6 +88,7 @@ When a day inside the current month is focused:
8288
- Arrow keys will navigate through the days.
8389
- Arrow keys will allow navigation to previous/next month as well.
8490
- `Enter` will select the currently focused day.
91+
- When more than one month view is displayed, navigating with the arrow keys should move to next/previous month after navigating from first/last day in current month.
8592

8693
When a month inside the months view is focused:
8794
- Arrow keys will navigate through the months.
@@ -154,6 +161,13 @@ The default values are listed below.
154161
{ day: false, month: true, year: false }
155162
```
156163

164+
- `monthViewsNumber: number`
165+
Controls the number of month views displayed. Default is 1.
166+
167+
- `hideOusideDays: boolean`
168+
Controls the visibility of the dates that do not belong to the current month.
169+
170+
157171
### Outputs
158172

159173
- `onSelection(): Date | Date[]`

projects/igniteui-angular/src/lib/date-picker/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ The DatePicker also supports binding through `ngModel` if two-way date-bind is n
5959
</igx-date-picker>
6060
```
6161

62+
A date-picker opening a calendar than one month in the view and hiding the days that are outside of the current month
63+
```html
64+
<igx-date-picker monthsViewNumber="2" [hideOutsideDays]="'true'">
65+
</igx-date-picker>
66+
```
67+
6268
The DatePicker has `dropdown` mode as well. Custom display format and editor mask can be configured by setting the `format` and `mask` properties.
6369
```html
6470
<igx-date-picker [(ngModel)]="myDateValue" mode="dropdown" mask="dd-MM-y">
@@ -127,6 +133,8 @@ The DatePicker action buttons could be retemplated.
127133
| `vertical` | `boolean` | Configure the calendar mode - horizontal or vertical in read-only datePicker. |
128134
| `mode` | `InteractionMode` | Configure the datePicker mode - `dialog` or `dropdown`. In `dropdown` mode, the datePicker input is editable and drop down calendar is displayed, in a `dialog` mode - the input is read-only and calendar dialog appears to select a date.|
129135
| `isSpinLoop` | `boolean` | Configure whether the date parts would spin continuously or stop when min/max value is reached in `dropdown` mode.|
136+
| `monthViewsNumber` | `number` | Controls the number of month views displayed. |
137+
| `hideOutsideDays`| `boolean` | Controls the visibility of the dates that do not belong to the current month. |
130138

131139

132140
### Outputs

0 commit comments

Comments
 (0)