Skip to content

Commit 2f10b9c

Browse files
committed
task(docs): updated markdown
1 parent a96bff6 commit 2f10b9c

File tree

11 files changed

+410
-0
lines changed

11 files changed

+410
-0
lines changed

packages/docs/src/markdown/developing/faq.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,20 @@ examples: Faq
66

77
Here you will find useful bespoke information on how to use the calendars. These mainly come as a result from question in the issues.
88

9+
## Month (Sticky Header)
10+
11+
In this example, check out the custom `.my-sticky` css class. This works in conjunction with a parent whose height is horter than the height needed to display the calendar and setting it's style to `overflow: auto`.
12+
913
<MarkdownExample title="Month (Sticky Header)" file="MonthSticky" no-github no-edit/>
1014

15+
## Month (Show Month)
16+
17+
In this example, it shows how you can display the currently displayed month and year. It uses the browser's `Intl.DateTimeFormat` to do the formatting.
18+
1119
<MarkdownExample title="Month (Show Month)" file="MonthDate" no-github no-edit/>
1220

21+
## Month (Min. Weeks)
22+
23+
In this example, it shows how you can display the minimum number of weeks displayed in a month. The reason form doing this is to make sure the calendar is always the same height.
24+
1325
<MarkdownExample title="Month (Min. Weeks)" file="MonthMinWeeks" no-github no-edit/>

packages/docs/src/markdown/developing/qcalendar-agenda.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,20 @@ import QCalendarAgendaApi from '@quasar/quasar-ui-qcalendar/dist/api/QCalendarAg
1010

1111
<MarkdownApi :api="QCalendarAgendaApi" name="QCalendarAgenda"/>
1212

13+
## Dark
14+
15+
This will only make sense if your browser is currently in light mode.
16+
1317
<MarkdownExample title="Dark" file="AgendaDark" no-github no-edit/>
1418

19+
## Alignment
20+
1521
You can use the properties `date-header`, `date-align` and `weekday-align` to manipulate how the header area looks.
1622

1723
<MarkdownExample title="Alignment" file="AgendaAlignment" no-github no-edit/>
1824

25+
## Cell Width
26+
1927
You can specify the `cell-width` property to make your calendar overrun it's horizontal boundaries.
2028

2129
The calendar goes into a special `sticky` mode when this happens so you can scroll vertically and/or horizontally.
@@ -24,22 +32,34 @@ This example also uses the `max-days` property.
2432

2533
<MarkdownExample title="Cell Width" file="AgendaCellWidth" no-github no-edit/>
2634

35+
## Column Count
36+
2737
The `column-count` property allows for a single day to be displayed multiple times.
2838

2939
<MarkdownExample title="Column Count" file="AgendaColumnCount" no-github no-edit/>
3040

41+
## Column Options
42+
3143
The `column-options` property allows you to define additional left or right columns.
3244

3345
<MarkdownExample title="Column Options" file="AgendaColumnOptions" no-github no-edit/>
3446

47+
## Date Type
48+
3549
<MarkdownExample title="Date Type" file="AgendaDateType" no-github no-edit/>
3650

51+
## Day Week - Max. Days
52+
3753
<MarkdownExample title="Day Week - Max Days" file="AgendaDayWeekMaxDays" no-github no-edit/>
3854

55+
## Disabled Before After
56+
3957
All days before and after the current day have been disabled with the properties `disabled-before` and `disabled-after`.
4058

4159
<MarkdownExample title="Disabled Before After" file="AgendaDisabledBeforeAfter" no-github no-edit/>
4260

61+
## Disabled Days
62+
4363
The next 4 days after the current day have been disabled with the `disabled-days` property.
4464

4565
The first example uses an array of dates to disable each specific date.
@@ -48,26 +68,44 @@ The second example uses a range, which is an array within an array of start and
4868

4969
<MarkdownExample title="Disabled Days" file="AgendaDisabledDays" no-github no-edit/>
5070

71+
## Disabled Weekdays
72+
5173
The weekends have been disabled with the `disabled-weekdays` property.
5274

5375
<MarkdownExample title="Disabled Weekdays" file="AgendaDisabledWeekdays" no-github no-edit/>
5476

77+
## First Day Monday
78+
5579
<MarkdownExample title="First Day Monday" file="AgendaFirstDayMonday" no-github no-edit/>
5680

81+
## Five Day Workweek
82+
5783
<MarkdownExample title="Five Day Workweek" file="AgendaFiveDayWorkweek" no-github no-edit/>
5884

85+
## Locale
86+
5987
<MarkdownExample title="Locale" file="AgendaLocale" no-github no-edit/>
6088

89+
## No Active Date
90+
6191
<MarkdownExample title="No Active Date" file="AgendaNoActiveDate" no-github no-edit/>
6292

93+
## Now
94+
6395
The current date has been set to tomorrow via the `now` property.
6496

6597
<MarkdownExample title="Now" file="AgendaNow" no-github no-edit/>
6698

99+
## Theme
100+
67101
<MarkdownExample title="Theme" file="AgendaTheme" no-github no-edit/>
68102

103+
## Transitions
104+
69105
<MarkdownExample title="Transitions" file="AgendaTransitions" no-github no-edit/>
70106

107+
## Planner
108+
71109
This is a rudimentary Planner using QCalendarAgenda.
72110

73111
::: tip

packages/docs/src/markdown/developing/qcalendar-day-intervals.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ import QCalendarDayApi from '@quasar/quasar-ui-qcalendar/dist/api/QCalendarDay.j
1010

1111
<MarkdownApi :api="QCalendarDayApi" name="QCalendarDay"/>
1212

13+
## Month Cell Width
14+
1315
<MarkdownExample title="Month Cell Width" file="IntervalsMonthCellWidth" no-github no-edit/>
1416

17+
## Month Navigation
18+
1519
<MarkdownExample title="Month Navigation" file="IntervalsMonthNavigation" no-github no-edit/>

packages/docs/src/markdown/developing/qcalendar-day-week.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,38 @@ import QCalendarDayApi from '@quasar/quasar-ui-qcalendar/dist/api/QCalendarDay.j
1010

1111
<MarkdownApi :api="QCalendarDayApi" name="QCalendarDay"/>
1212

13+
## Dark
14+
15+
This will only make sense if your browser is currently in light mode.
16+
1317
<MarkdownExample title="Dark" file="WeekDark" no-github no-edit/>
1418

19+
## Alignment
20+
1521
You can use the properties `date-header`, `date-align` and `weekday-align` to manipulate how the header area looks.
1622

1723
<MarkdownExample title="Alignment" file="WeekAlignment" no-github no-edit/>
1824

25+
## Cell Width
26+
1927
You can specify the `cell-width` property to make your calendar overrun it's horizontal boundaries.
2028

2129
The calendar goes into a special `sticky` mode when this happens so you can scroll vertically and/or horizontally.
2230

2331
<MarkdownExample title="Cell Width" file="WeekCellWidth" no-github no-edit/>
2432

33+
## Date Type
34+
2535
<MarkdownExample title="Date Type" file="WeekDateType" no-github no-edit/>
2636

37+
## Disabled Before After
38+
2739
All days before and after the current day have been disabled with the properties `disabled-before` and `disabled-after`.
2840

2941
<MarkdownExample title="Disabled Before After" file="WeekDisabledBeforeAfter" no-github no-edit/>
3042

43+
## Disabled Days
44+
3145
The next 4 days after the current day have been disabled with the `disabled-days` property.
3246

3347
The first example uses an array of dates to disable each specific date.
@@ -36,10 +50,14 @@ The second example uses a range, which is an array within an array of start and
3650

3751
<MarkdownExample title="Disabled Days" file="WeekDisabledDays" no-github no-edit/>
3852

53+
## Disabled Weekdays
54+
3955
The weekends have been disabled with the `disabled-weekdays` property.
4056

4157
<MarkdownExample title="Disabled Weekdays" file="WeekDisabledWeekdays" no-github no-edit/>
4258

59+
## Drag and Drop
60+
4361
Drag any items in the list to a calendar interval or the top header.
4462

4563
::: tip
@@ -50,28 +68,48 @@ Instead use `box-shadow` to create an inset like this `box-shadow: inset 0 0 0 1
5068

5169
<MarkdownExample title="Drag and Drop" file="WeekDragAndDrop" no-github no-edit/>
5270

71+
## First Day Monday
72+
5373
<MarkdownExample title="First Day Monday" file="WeekFirstDayMonday" no-github no-edit/>
5474

75+
## Five Day Workweek
76+
5577
<MarkdownExample title="Five Day Workweek" file="WeekFiveDayWorkweek" no-github no-edit/>
5678

79+
## Focusable/Hoverable
80+
5781
::: tip
5882
If the property `focus-type` contains `weekday`, you can also use the <kbd>Enter</kbd> or <kbd>Space</kbd> keys for date selection.
5983
:::
6084

6185
<MarkdownExample title="Focusable/Hoverable" file="WeekFocusableHoverable" no-github no-edit/>
6286

87+
## Interval Count
88+
6389
<MarkdownExample title="Interval Count" file="WeekIntervalCount" no-github no-edit/>
6490

91+
## Interval Height
92+
6593
<MarkdownExample title="Interval Height" file="WeekIntervalHeight" no-github no-edit/>
6694

95+
## Interval Minutes (15)
96+
6797
<MarkdownExample title="Interval Minutes (15)" file="WeekIntervalMinutes15" no-github no-edit/>
6898

99+
## Interval Minutes (30)
100+
69101
<MarkdownExample title="Interval Minutes (30)" file="WeekIntervalMinutes30" no-github no-edit/>
70102

103+
## Interval Start
104+
71105
<MarkdownExample title="Interval Start" file="WeekIntervalStart" no-github no-edit/>
72106

107+
## Locale
108+
73109
<MarkdownExample title="Locale" file="WeekLocale" no-github no-edit/>
74110

111+
## Modify Intervals
112+
75113
Using the proerties `interval-minutes`, `interval-start` and `interval-count`, you can control how the calendar looks in terms of the range of intervals.
76114

77115
This has been a difficult concept for some to grasp.
@@ -82,6 +120,8 @@ Now, we change interval minutes to 15 (for 15 minute segmented intervals). That
82120

83121
<MarkdownExample title="Modify Intervals" file="WeekModifyIntervals" no-github no-edit/>
84122

123+
## Navigation
124+
85125
This example uses the `use-navigation` property along with the `focusable` and `focus-type` properties.
86126

87127
If the calendar has focus you can use the <kbd>&larr;</kbd> and <kbd>&rarr;</kbd> keys on your keyboard for navigation.
@@ -90,10 +130,16 @@ On the intervals, you can use <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd>
90130

91131
<MarkdownExample title="Navigation" file="WeekNavigation" no-github no-edit/>
92132

133+
## No Active Date
134+
93135
<MarkdownExample title="No Active Date" file="WeekNoActiveDate" no-github no-edit/>
94136

137+
## No Header
138+
95139
<MarkdownExample title="No Header" file="WeekNoHeader" no-github no-edit/>
96140

141+
## No Scroll
142+
97143
When the property `no-scroll` is used, you must provide an outter div that has `overflow: auto` to control the scrolling.
98144

99145
::: tip
@@ -102,12 +148,18 @@ Note that the date header now scrolls with the rest of the calendar.
102148

103149
<MarkdownExample title="No Scroll" file="WeekNoScroll" no-github no-edit/>
104150

151+
## Now
152+
105153
The current date has been set to tomorrow via the `now` property.
106154

107155
<MarkdownExample title="Now" file="WeekNow" no-github no-edit/>
108156

157+
## Selected Intervals
158+
109159
<MarkdownExample title="Selected Intervals" file="WeekSelectedIntervals" no-github no-edit/>
110160

161+
## Selection
162+
111163
The example below uses the `selected-start-end-dates` property in conjunction with mouse events to select interval ranges.
112164

113165
::: tip
@@ -116,24 +168,40 @@ Try toggling the `Mobile selection` to see how selection can be changed.
116168

117169
<MarkdownExample title="Selection" file="WeekSelection" no-github no-edit/>
118170

171+
## Slot - Column Header
172+
119173
<MarkdownExample title="Slot - Column Header" file="WeekSlotColumnHeader" no-github no-edit/>
120174

175+
## Slot - Day Body
176+
121177
This example uses both the `day-body` and `head-day-event` slots.
122178

123179
You can click the `head-day-event` badges which will call the calendar's `scrolltoTime` method.
124180

125181
<MarkdownExample title="Slot - Day Body" file="WeekSlotDayBody" no-github no-edit/>
126182

183+
## Slot - Day Container (Show Current Time)
184+
127185
<MarkdownExample title="Slot - Day Container (Show Current Time)" file="WeekSlotDayContainerShowCurrentTime" no-github no-edit/>
128186

129187
<MarkdownExample title="Slot - Day Interval" file="WeekSlotDayInterval" no-github no-edit/>
130188

189+
## Slot - Head Day
190+
131191
<MarkdownExample title="Slot - Head Day" file="WeekSlotHeadDay" no-github no-edit/>
132192

193+
## Slot - Head Day (Event)
194+
133195
<MarkdownExample title="Slot - Head Day (Event)" file="WeekSlotHeadDayEvent" no-github no-edit/>
134196

197+
## Slot - Head Intervals
198+
135199
<MarkdownExample title="Slot - Head Intervals" file="WeekSlotHeadIntervals" no-github no-edit/>
136200

201+
## Theme
202+
137203
<MarkdownExample title="Theme" file="WeekTheme" no-github no-edit/>
138204

205+
## Transitions
206+
139207
<MarkdownExample title="Transitions" file="WeekTransitions" no-github no-edit/>

0 commit comments

Comments
 (0)