Skip to content

Commit

Permalink
fix(calendar): docs typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Tibing committed Aug 7, 2018
1 parent 947e7d1 commit a350f1b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import { NbCalendarCell, NbCalendarSize, NbCalendarViewMode, NbDateTimeUtil } fr


/**
* Basis for calendar and range calendar components.
* Encapsulates common behaviour - store calendar state and perform navigation
* The basis for calendar and range calendar components.
* Encapsulates common behavior - store calendar state and perform navigation
* between pickers.
* */
@Component({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface NbCalendarRange {
}

/**
* Calendar component provides capability to choose ranges.
* Calendar component provides a capability to choose ranges.
* For additional info check `NbBaseCalendarComponent`.
*
* ```html
Expand Down Expand Up @@ -49,22 +49,22 @@ export class NbCalendarRangeComponent {
@Input() boundingMonth: boolean = true;

/**
* Defines starting view for calendar.
* Defines starting view for the calendar.
* */
@Input() startView: NbCalendarViewMode = NbCalendarViewMode.DATE;

/**
* Minimum available date for selection.
* A minimum available date for selection.
* */
@Input() min: Date;

/**
* Maximum available date for selection.
* A maximum available date for selection.
* */
@Input() max: Date;

/**
* Predicate that decides which cells will be disabled.
* A predicate that decides which cells will be disabled.
* */
@Input() filter: (Date) => boolean;

Expand Down
10 changes: 5 additions & 5 deletions src/framework/theme/components/calendar/calendar.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { NbCalendarCell, NbCalendarSize, NbCalendarViewMode } from '../calendar-


/**
* Calendar component provides capability to choose date.
* Calendar component provides a capability to choose a date.
*
* ```html
* <nb-calendar [(date)]="date"></nb-calendar>
Expand All @@ -30,22 +30,22 @@ import { NbCalendarCell, NbCalendarSize, NbCalendarViewMode } from '../calendar-
* Available values: year, month and date.
* @stacked-example(Start view, calendar/calendar-start-view.component)
*
* You can use larger version of the calendar by defining size property.
* You can use a larger version of the calendar by defining size property.
* Available values: medium(which is default) and large.
* @stacked-example(Size, calendar/calendar-size.component)
*
* Calendar supports min and max dates which disables values out of min-max range.
* @stacked-example(Borders, calendar/calendar-min-max.component)
*
* Also you can define custom filter property that should be predicate which receives
* date and returns false if this date have to be disables. In this example we provide filter
* Also, you can define custom filter property that should be predicate which receives
* date and returns false if this date has to be disabled. In this example, we provide the filter
* which disables weekdays.
* @stacked-example(Filter, calendar/calendar-filter.component)
*
* If you need create custom cells you can easily provide custom components for
* calendar. For examples if you wanna show any average price under each date you can
* just provide custom `dayCellComponent`. Custom cells for month and year can be provided
* same way, check api reference.
* the same way, check API reference.
* @stacked-example(Custom day cell, calendar/calendar-custom-day-cell-showcase.component)
*
* @styles
Expand Down

0 comments on commit a350f1b

Please sign in to comment.