Skip to content

Commit

Permalink
docs: add 'since' annotations for 14.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
maxokorokov committed May 23, 2023
1 parent 23eb959 commit ed87d29
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 13 deletions.
5 changes: 4 additions & 1 deletion src/datepicker/datepicker-content-template-context.ts
Expand Up @@ -3,7 +3,10 @@ import { NgbDatepicker } from './datepicker';
/**
* The context for the datepicker 'content' template.
*
* You can override the way content is displayed in the datepicker via the `[contentTemplate]` input.
* You can override the way content is displayed in the datepicker via the `[contentTemplate]` input
* or via the [`NgbDatepickerContent`](#/components/datepicker/api#NgbDatepickerContent) directive.
*
* @since 14.2.0
*/
export interface ContentTemplateContext {
/**
Expand Down
2 changes: 2 additions & 0 deletions src/datepicker/datepicker-input.ts
Expand Up @@ -101,6 +101,8 @@ export class NgbInputDatepicker implements OnChanges, OnDestroy, ControlValueAcc
* Allows to completely override the way datepicker.
*
* See [`NgbDatepickerContent`](#/components/datepicker/api#NgbDatepickerContent) for more details.
*
* @since 14.2.0
*/
@Input() contentTemplate: TemplateRef<ContentTemplateContext>;

Expand Down
7 changes: 6 additions & 1 deletion src/datepicker/datepicker.ts
Expand Up @@ -295,7 +295,10 @@ export class NgbDatepicker implements AfterViewInit, OnDestroy, OnChanges, OnIni
*
* Allows to completely override the way datepicker displays months.
*
* See [`NgbDatepickerContent`](#/components/datepicker/api#NgbDatepickerContent) for more details.
* See [`NgbDatepickerContent`](#/components/datepicker/api#NgbDatepickerContent) and
* [`ContentTemplateContext`](#/components/datepicker/api#ContentTemplateContext) for more details.
*
* @since 14.2.0
*/
@Input() contentTemplate: TemplateRef<ContentTemplateContext>;
@ContentChild(NgbDatepickerContent, { static: true }) contentTemplateFromContent?: NgbDatepickerContent;
Expand Down Expand Up @@ -529,6 +532,8 @@ export class NgbDatepicker implements AfterViewInit, OnDestroy, OnChanges, OnIni

/**
* Returns the i18n service used in the specific datepicker instance.
*
* @since 14.2.0
*/
get i18n(): NgbDatepickerI18n {
return this._i18n;
Expand Down
2 changes: 1 addition & 1 deletion src/dropdown/dropdown.ts
Expand Up @@ -31,7 +31,7 @@ import { NgbDropdownConfig } from './dropdown-config';
import { FOCUSABLE_ELEMENTS_SELECTOR } from '../util/focus-trap';

/**
* @deprecated this directive isn't useful anymore. You can remove it from your imports
* @deprecated 14.2.0 this directive isn't useful anymore. You can remove it from your imports
*/
@Directive({ selector: '.navbar', standalone: true })
export class NgbNavbar {}
Expand Down
4 changes: 3 additions & 1 deletion src/modal/modal-config.ts
Expand Up @@ -122,7 +122,9 @@ export interface NgbModalOptions {
}

/**
* Options available on a opened modal windows with `NgbModalRef.update()` and `NgbActiveModal.update()` methods.
* Options that can be changed on an opened modal with `NgbModalRef.update()` and `NgbActiveModal.update()` methods.
*
* @since 14.2.0
*/
export type NgbModalUpdatableOptions = Pick<
NgbModalOptions,
Expand Down
6 changes: 4 additions & 2 deletions src/modal/modal-ref.ts
Expand Up @@ -19,8 +19,9 @@ import { isPromise } from '../util/util';
*/
export class NgbActiveModal {
/**
* Update options of an opened modal with `options` value.
* Updates options of an opened modal.
*
* @since 14.2.0
*/
update(options: NgbModalUpdatableOptions): void {}
/**
Expand Down Expand Up @@ -80,8 +81,9 @@ export class NgbModalRef {
}

/**
* Update options of an opened modal with `options` value.
* Updates options of an opened modal.
*
* @since 14.2.0
*/
update(options: NgbModalUpdatableOptions): void {
this._applyWindowOptions(this._windowCmptRef.instance, options);
Expand Down
14 changes: 7 additions & 7 deletions src/typeahead/typeahead.ts
Expand Up @@ -113,13 +113,6 @@ export class NgbTypeahead implements ControlValueAccessor, OnInit, OnChanges, On
*/
@Input() focusFirst: boolean;

/**
* If `true`, automatically selects the item when it is the only one that exactly matches the user input
*
* @since 13.2.0
*/
@Input() selectOnExact: boolean;

/**
* The function that converts an item from the result list to a `string` to display in the `<input>` field.
*
Expand Down Expand Up @@ -159,6 +152,13 @@ export class NgbTypeahead implements ControlValueAccessor, OnInit, OnChanges, On
*/
@Input() resultTemplate: TemplateRef<ResultTemplateContext>;

/**
* If `true`, automatically selects the item when it is the only one that exactly matches the user input
*
* @since 14.2.0
*/
@Input() selectOnExact: boolean;

/**
* If `true`, will show the hint in the `<input>` when an item in the result list matches.
*/
Expand Down

0 comments on commit ed87d29

Please sign in to comment.