/* tslint:disable */ export const ngdoc: any = { "AccordionPanelComponent": { "fileName": "src/accordion/accordion-group.component.ts", "className": "AccordionPanelComponent", "description": "

Accordion heading

\n

Instead of using heading attribute on the accordion-group, you can use\nan accordion-heading attribute on any element inside of a group that\nwill be used as group's header template.

\n", "selector": "accordion-group, accordion-panel", "inputs": [ { "name": "heading", "type": "string", "description": "

Clickable text in accordion's group header, check accordion heading below for using html in header

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

if true — disables accordion group

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Is accordion group open or closed. This property supports two-way binding

\n" }, { "name": "panelClass", "defaultValue": "panel-default", "type": "string", "description": "

Provides an ability to use Bootstrap's contextual panel classes\n(panel-primary, panel-success, panel-info, etc...).\nList of all available classes [available here]\n(https://getbootstrap.com/docs/3.3/components/#panels-alternatives)

\n" } ], "outputs": [ { "name": "isOpenChange", "description": "

Emits when the opened state changes

\n" } ], "properties": [ { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" } ], "methods": [] }, "AccordionComponent": { "fileName": "src/accordion/accordion.component.ts", "className": "AccordionComponent", "description": "

Displays collapsible content panels for presenting information in a limited amount of space.

\n", "selector": "accordion", "inputs": [ { "name": "closeOthers", "defaultValue": "false", "type": "boolean", "description": "

if true expanding one item will close all others

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" } ], "outputs": [], "properties": [], "methods": [] }, "AccordionConfig": { "fileName": "src/accordion/accordion.config.ts", "className": "AccordionConfig", "description": "

Configuration service, provides default values for the AccordionComponent.

\n", "methods": [], "properties": [ { "name": "closeOthers", "defaultValue": "false", "type": "boolean", "description": "

Whether the other panels should be closed when a panel is opened

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" } ] }, "AlertComponent": { "fileName": "src/alert/alert.component.ts", "className": "AlertComponent", "description": "", "selector": "alert,bs-alert", "inputs": [ { "name": "dismissible", "defaultValue": "false", "type": "boolean", "description": "

If set, displays an inline "Close" button

\n" }, { "name": "dismissOnTimeout", "type": "string | number", "description": "

Number in milliseconds, after which alert will be closed

\n" }, { "name": "isOpen", "defaultValue": "true", "type": "boolean", "description": "

Is alert visible

\n" }, { "name": "type", "defaultValue": "warning", "type": "string", "description": "

Alert type.\nProvides one of four bootstrap supported contextual classes:\nsuccess, info, warning and danger

\n" } ], "outputs": [ { "name": "onClose", "description": "

This event fires immediately after close instance method is called,\n$event is an instance of Alert component.

\n" }, { "name": "onClosed", "description": "

This event fires when alert closed, $event is an instance of Alert component

\n" } ], "properties": [], "methods": [ { "name": "close", "description": "

Closes an alert by removing it from the DOM.

\n", "args": [], "returnType": "void" } ] }, "AlertConfig": { "fileName": "src/alert/alert.config.ts", "className": "AlertConfig", "description": "", "methods": [], "properties": [ { "name": "dismissible", "defaultValue": "false", "type": "boolean", "description": "

is alerts are dismissible by default

\n" }, { "name": "dismissOnTimeout", "defaultValue": "undefined", "type": "number", "description": "

default time before alert will dismiss

\n" }, { "name": "type", "defaultValue": "warning", "type": "string", "description": "

default alert type

\n" } ] }, "ButtonCheckboxDirective": { "fileName": "src/buttons/button-checkbox.directive.ts", "className": "ButtonCheckboxDirective", "description": "

Add checkbox functionality to any element

\n", "selector": "[btnCheckbox]", "inputs": [ { "name": "btnCheckboxFalse", "defaultValue": "false", "type": "AvailableValues", "description": "

Falsy value, will be set to ngModel

\n" }, { "name": "btnCheckboxTrue", "defaultValue": "true", "type": "AvailableValues", "description": "

Truthy value, will be set to ngModel

\n" } ], "outputs": [], "properties": [], "methods": [] }, "ButtonRadioGroupDirective": { "fileName": "src/buttons/button-radio-group.directive.ts", "className": "ButtonRadioGroupDirective", "description": "

A group of radio buttons.\nA value of a selected button is bound to a variable specified via ngModel.

\n", "selector": "[btnRadioGroup]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "ButtonRadioDirective": { "fileName": "src/buttons/button-radio.directive.ts", "className": "ButtonRadioDirective", "description": "

Create radio buttons or groups of buttons.\nA value of a selected button is bound to a variable specified via ngModel.

\n", "selector": "[btnRadio]", "inputs": [ { "name": "btnRadio", "type": "string", "description": "

Radio button value, will be set to ngModel

\n" }, { "name": "disabled", "type": "boolean", "description": "

If true — radio button is disabled

\n" }, { "name": "uncheckable", "defaultValue": "false", "type": "boolean", "description": "

If true — radio button can be unchecked

\n" }, { "name": "value", "type": "string", "description": "

Current value of radio component or group

\n" } ], "outputs": [], "properties": [], "methods": [] }, "CarouselComponent": { "fileName": "src/carousel/carousel.component.ts", "className": "CarouselComponent", "description": "

Base element to create carousel

\n", "selector": "carousel", "inputs": [ { "name": "activeSlide", "type": "number", "description": "

Index of currently displayed slide(started for 0)

\n" }, { "name": "indicatorsByChunk", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "interval", "type": "number", "description": "

Delay of item cycling in milliseconds. If false, carousel won't cycle\nautomatically.

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

Turn on/off animation. Animation doesn't work for multilist carousel

\n" }, { "name": "itemsPerSlide", "defaultValue": "1", "type": "number", "description": "" }, { "name": "noPause", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "noWrap", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "pauseOnFocus", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "showIndicators", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "singleSlideOffset", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "startFromIndex", "defaultValue": "0", "type": "number", "description": "" } ], "outputs": [ { "name": "activeSlideChange", "description": "

Will be emitted when active slide has been changed. Part of two-way-bindable [(activeSlide)] property

\n" }, { "name": "slideRangeChange", "description": "

Will be emitted when active slides has been changed in multilist mode

\n" } ], "properties": [ { "name": "activeSlide", "type": "number", "description": "

Index of currently displayed slide(started for 0)

\n" } ], "methods": [ { "name": "addSlide", "description": "

Adds new slide. If this slide is first in collection - set it as active\nand starts auto changing

\n", "args": [ { "name": "slide", "type": "SlideComponent" } ], "returnType": "void" }, { "name": "removeSlide", "description": "

Removes specified slide. If this slide is active - will roll to another\nslide

\n", "args": [ { "name": "slide", "type": "SlideComponent" } ], "returnType": "void" }, { "name": "nextSlide", "description": "

Rolling to next slide

\n", "args": [ { "name": "force", "type": "boolean" } ], "returnType": "void" }, { "name": "previousSlide", "description": "

Rolling to previous slide

\n", "args": [ { "name": "force", "type": "boolean" } ], "returnType": "void" }, { "name": "keydownPress", "description": "

Swith slides by enter, space and arrows keys

\n", "args": [ { "name": "event", "type": "KeyboardEvent" } ], "returnType": "void" }, { "name": "onMouseLeave", "description": "

Play on mouse leave

\n", "args": [], "returnType": "void" }, { "name": "onMouseUp", "description": "

Play on mouse up

\n", "args": [], "returnType": "void" }, { "name": "pauseFocusIn", "description": "

When slides on focus autoplay is stopped(optional)

\n", "args": [], "returnType": "void" }, { "name": "pauseFocusOut", "description": "

When slides out of focus autoplay is started

\n", "args": [], "returnType": "void" }, { "name": "selectSlide", "description": "

Rolling to specified slide

\n", "args": [ { "name": "index", "type": "number" } ], "returnType": "void" }, { "name": "play", "description": "

Starts a auto changing of slides

\n", "args": [], "returnType": "void" }, { "name": "pause", "description": "

Stops a auto changing of slides

\n", "args": [], "returnType": "void" }, { "name": "getCurrentSlideIndex", "description": "

Finds and returns index of currently displayed slide

\n", "args": [], "returnType": "number" }, { "name": "isLast", "description": "

Defines, whether the specified index is last in collection

\n", "args": [ { "name": "index", "type": "number" } ], "returnType": "boolean" }, { "name": "isFirst", "description": "

Defines, whether the specified index is first in collection

\n", "args": [ { "name": "index", "type": "number" } ], "returnType": "boolean" }, { "name": "findNextSlideIndex", "description": "

Defines next slide index, depending of direction

\n", "args": [ { "name": "direction", "type": "Direction" }, { "name": "force", "type": "boolean" } ], "returnType": "number | void" }, { "name": "_select", "description": "

Sets a slide, which specified through index, as active

\n", "args": [ { "name": "index", "type": "number" } ], "returnType": "void" }, { "name": "restartTimer", "description": "

Starts loop of auto changing of slides

\n", "args": [], "returnType": "void" }, { "name": "resetTimer", "description": "

Stops loop of auto changing of slides

\n", "args": [], "returnType": "void" } ] }, "CarouselConfig": { "fileName": "src/carousel/carousel.config.ts", "className": "CarouselConfig", "description": "", "methods": [], "properties": [] }, "SlideWithIndex": { "fileName": "src/carousel/models/index.ts", "className": "SlideWithIndex", "description": "", "methods": [], "properties": [] }, "IndexedSlideList": { "fileName": "src/carousel/models/index.ts", "className": "IndexedSlideList", "description": "", "methods": [], "properties": [] }, "SlideComponent": { "fileName": "src/carousel/slide.component.ts", "className": "SlideComponent", "description": "", "selector": "slide", "inputs": [ { "name": "active", "defaultValue": "false", "type": "boolean", "description": "

Is current slide active

\n" } ], "outputs": [], "properties": [ { "name": "addClass", "defaultValue": "true", "type": "boolean", "description": "

Wraps element by appropriate CSS classes

\n" }, { "name": "carousel", "type": "CarouselComponent", "description": "

Link to Parent(container-collection) component

\n" } ], "methods": [] }, "DateParsingConfig": { "fileName": "src/chronos/create/parsing.types.ts", "className": "DateParsingConfig", "description": "", "methods": [], "properties": [ { "name": "_a", "type": "DateArray", "description": "

DateArray [year, month, date, .....]

\n" }, { "name": "_changeInProgress", "type": "boolean", "description": "

used in set offset

\n" }, { "name": "_d", "type": "Date", "description": "

date value

\n" }, { "name": "_f", "type": "string | string[]", "description": "

date format

\n" }, { "name": "_i", "type": "DateInput", "description": "

input to parse: could be string, number[], number, Date, object

\n" }, { "name": "_isPm", "type": "boolean", "description": "

is PM

\n" }, { "name": "_isValid", "type": "boolean", "description": "

is valid

\n" }, { "name": "_l", "type": "string", "description": "

locale key, 'en' by default

\n" }, { "name": "_locale", "type": "Locale", "description": "

date locale obj

\n" }, { "name": "_meridiem", "type": "string", "description": "

date meridiem

\n" }, { "name": "_nextDay", "type": "boolean", "description": "

add one day to result at the end of parsing

\n" }, { "name": "_offset", "type": "number", "description": "

utc time offset

\n" }, { "name": "_pf", "type": "DateParsingFlags", "description": "

date parsing flags

\n" }, { "name": "_strict", "type": "boolean", "description": "

use strict parse format

\n" }, { "name": "_tzm", "type": "number", "description": "

time zone

\n" }, { "name": "_w", "type": "WeekParsing", "description": "

week

\n" } ] }, "DateParsingFlags": { "fileName": "src/chronos/create/parsing.types.ts", "className": "DateParsingFlags", "description": "", "methods": [], "properties": [] }, "LocaleOptionsFormat": { "fileName": "src/chronos/locale/locale.class.ts", "className": "LocaleOptionsFormat", "description": "", "methods": [], "properties": [] }, "LocaleData": { "fileName": "src/chronos/locale/locale.class.ts", "className": "LocaleData", "description": "", "methods": [], "properties": [] }, "CalendarSpec": { "fileName": "src/chronos/moment/calendar.ts", "className": "CalendarSpec", "description": "", "methods": [], "properties": [] }, "MomentFn": { "fileName": "src/chronos/testing/chain.ts", "className": "MomentFn", "description": "", "methods": [], "properties": [] }, "MomentInputObject": { "fileName": "src/chronos/testing/chain.ts", "className": "MomentInputObject", "description": "", "methods": [], "properties": [] }, "TimeUnit": { "fileName": "src/chronos/types.ts", "className": "TimeUnit", "description": "", "methods": [], "properties": [] }, "DateFormatterOptions": { "fileName": "src/chronos/types.ts", "className": "DateFormatterOptions", "description": "", "methods": [], "properties": [] }, "DateObject": { "fileName": "src/chronos/types.ts", "className": "DateObject", "description": "", "methods": [], "properties": [] }, "WeekParsing": { "fileName": "src/chronos/types.ts", "className": "WeekParsing", "description": "", "methods": [], "properties": [] }, "CollapseDirective": { "fileName": "src/collapse/collapse.directive.ts", "className": "CollapseDirective", "description": "", "selector": "[collapse]", "exportAs": "bs-collapse", "inputs": [ { "name": "collapse", "type": "boolean", "description": "

A flag indicating visibility of content (shown or hidden)

\n" }, { "name": "display", "type": "string", "description": "" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" } ], "outputs": [ { "name": "collapsed", "description": "

This event fires as soon as content collapses

\n" }, { "name": "collapses", "description": "

This event fires when collapsing is started

\n" }, { "name": "expanded", "description": "

This event fires as soon as content becomes visible

\n" }, { "name": "expands", "description": "

This event fires when expansion is started

\n" } ], "properties": [ { "name": "collapse", "type": "boolean", "description": "

A flag indicating visibility of content (shown or hidden)

\n" } ], "methods": [ { "name": "toggle", "description": "

allows to manually toggle content visibility

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

allows to manually hide content

\n", "args": [], "returnType": "void" }, { "name": "show", "description": "

allows to manually show collapsed content

\n", "args": [], "returnType": "void" } ] }, "ComponentLoaderFactory": { "fileName": "src/component-loader/component-loader.factory.ts", "className": "ComponentLoaderFactory", "description": "", "methods": [], "properties": [] }, "ListenOptions": { "fileName": "src/utils/triggers.ts", "className": "ListenOptions", "description": "", "methods": [], "properties": [] }, "BsDatepickerInlineDirective": { "fileName": "src/datepicker/bs-datepicker-inline.component.ts", "className": "BsDatepickerInlineDirective", "description": "", "selector": "bs-datepicker-inline", "exportAs": "bsDatepickerInline", "inputs": [ { "name": "bsConfig", "type": "Partial", "description": "

Config object for datepicker

\n" }, { "name": "bsValue", "type": "Date", "description": "

Initial value of datepicker

\n" }, { "name": "dateCustomClasses", "type": "DatepickerDateCustomClasses[]", "description": "

Date custom classes

\n" }, { "name": "datesDisabled", "type": "Date[]", "description": "

Enable specific dates

\n" }, { "name": "datesEnabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "dateTooltipTexts", "type": "DatepickerDateTooltipText[]", "description": "

Date tooltip text

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

Indicates whether datepicker is enabled or not

\n" }, { "name": "maxDate", "type": "Date", "description": "

Maximum date which is available for selection

\n" }, { "name": "minDate", "type": "Date", "description": "

Minimum date which is available for selection

\n" } ], "outputs": [ { "name": "bsValueChange", "description": "

Emits when datepicker value has been changed

\n" } ], "properties": [], "methods": [ { "name": "setConfig", "description": "

Set config for datepicker

\n", "args": [], "returnType": "void" } ] }, "BsDatepickerInlineConfig": { "fileName": "src/datepicker/bs-datepicker-inline.config.ts", "className": "BsDatepickerInlineConfig", "description": "", "methods": [], "properties": [] }, "BsDatepickerInputDirective": { "fileName": "src/datepicker/bs-datepicker-input.directive.ts", "className": "BsDatepickerInputDirective", "description": "", "selector": "input[bsDatepicker]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDatepickerDirective": { "fileName": "src/datepicker/bs-datepicker.component.ts", "className": "BsDatepickerDirective", "description": "", "selector": "[bsDatepicker]", "exportAs": "bsDatepicker", "inputs": [ { "name": "bsConfig", "type": "Partial", "description": "

Config object for datepicker

\n" }, { "name": "bsValue", "type": "Date", "description": "

Initial value of datepicker

\n" }, { "name": "container", "defaultValue": "body", "type": "string", "description": "

A selector specifying the element the datepicker should be appended to.

\n" }, { "name": "dateCustomClasses", "type": "DatepickerDateCustomClasses[]", "description": "

Date custom classes

\n" }, { "name": "datesDisabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "datesEnabled", "type": "Date[]", "description": "

Enable specific dates

\n" }, { "name": "dateTooltipTexts", "type": "DatepickerDateTooltipText[]", "description": "

Date tooltip text

\n" }, { "name": "daysDisabled", "type": "number[]", "description": "

Disable Certain days in the week

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

Indicates whether datepicker's content is enabled or not

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Returns whether or not the datepicker is currently being shown

\n" }, { "name": "maxDate", "type": "Date", "description": "

Maximum date which is available for selection

\n" }, { "name": "minDate", "type": "Date", "description": "

Minimum date which is available for selection

\n" }, { "name": "minMode", "type": "BsDatepickerViewMode", "description": "

Minimum view mode : day, month, or year

\n" }, { "name": "outsideClick", "defaultValue": "true", "type": "boolean", "description": "

Close datepicker on outside click

\n" }, { "name": "outsideEsc", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "placement", "defaultValue": "bottom", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "

Placement of a datepicker. Accepts: "top", "bottom", "left", "right"

\n" }, { "name": "triggers", "defaultValue": "click", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" } ], "outputs": [ { "name": "bsValueChange", "description": "

Emits when datepicker value has been changed

\n" }, { "name": "onHidden", "description": "

Emits an event when the datepicker is hidden

\n" }, { "name": "onShown", "description": "

Emits an event when the datepicker is shown

\n" } ], "properties": [], "methods": [ { "name": "show", "description": "

Opens an element’s datepicker. This is considered a “manual” triggering of\nthe datepicker.

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Closes an element’s datepicker. This is considered a “manual” triggering of\nthe datepicker.

\n", "args": [], "returnType": "void" }, { "name": "toggle", "description": "

Toggles an element’s datepicker. This is considered a “manual” triggering\nof the datepicker.

\n", "args": [], "returnType": "void" }, { "name": "setConfig", "description": "

Set config for datepicker

\n", "args": [], "returnType": "void" } ] }, "BsDatepickerConfig": { "fileName": "src/datepicker/bs-datepicker.config.ts", "className": "BsDatepickerConfig", "description": "

For date range picker there are BsDaterangepickerConfig which inherits all properties,\nexcept displayMonths, for range picker it default to 2

\n", "methods": [], "properties": [ { "name": "adaptivePosition", "defaultValue": "false", "type": "boolean", "description": "

sets use adaptive position

\n" }, { "name": "clearButtonLabel", "defaultValue": "Clear", "type": "string", "description": "

Label for 'clear' button

\n" }, { "name": "clearPosition", "defaultValue": "right", "type": "string", "description": "

Positioning of 'clear' button

\n" }, { "name": "containerClass", "defaultValue": "theme-green", "type": "string", "description": "

CSS class which will be applied to datepicker container,\nusually used to set color theme

\n" }, { "name": "customRangeButtonLabel", "defaultValue": "Custom Range", "type": "string", "description": "

Label for 'custom range' button

\n" }, { "name": "customTodayClass", "type": "string", "description": "

Add class to current day

\n" }, { "name": "dateCustomClasses", "type": "DatepickerDateCustomClasses[]", "description": "

Default date custom classes for all date/range pickers

\n" }, { "name": "datesDisabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "datesEnabled", "type": "Date[]", "description": "

Enable specific dates

\n" }, { "name": "dateTooltipTexts", "type": "DatepickerDateTooltipText[]", "description": "

Default tooltip text for all date/range pickers

\n" }, { "name": "daysDisabled", "type": "number[]", "description": "

Disable specific days, e.g. [0,6] will disable all Saturdays and Sundays

\n" }, { "name": "displayOneMonthRange", "type": "boolean", "description": "

Show one months for special cases (only for dateRangePicker)

\n
    \n
  1. maxDate is equal to today's date
  2. \n
  3. minDate's month is equal to maxDate's month
  4. \n
\n" }, { "name": "initCurrentTime", "type": "boolean", "description": "

Set current hours, minutes, seconds and milliseconds for bsValue

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" }, { "name": "maxDate", "type": "Date", "description": "

Default max date for all date/range pickers

\n" }, { "name": "maxDateRange", "type": "number", "description": "

Max Date Range in days

\n" }, { "name": "minDate", "type": "Date", "description": "

Default min date for all date/range pickers

\n" }, { "name": "minMode", "type": "BsDatepickerViewMode", "description": "

Default mode for all date pickers

\n" }, { "name": "preventChangeToNextMonth", "type": "boolean", "description": "

Prevents change to next month for right calendar in two calendars view (dateRangePicker only)

\n" }, { "name": "rangeInputFormat", "defaultValue": "L", "type": "string", "description": "

Date format for date range input field

\n" }, { "name": "ranges", "type": "BsCustomDates[]", "description": "

Predefined ranges

\n" }, { "name": "returnFocusToInput", "defaultValue": "false", "type": "boolean", "description": "

If true, returns focus to the datepicker / daterangepicker input after date selection

\n" }, { "name": "selectFromOtherMonth", "type": "boolean", "description": "

Makes dates from other months active

\n" }, { "name": "selectWeek", "type": "boolean", "description": "

Allows select first date of the week by click on week number

\n" }, { "name": "selectWeekDateRange", "type": "boolean", "description": "

Allows select daterange as first and last day of week by click on week number (dateRangePicker only)

\n" }, { "name": "showClearButton", "defaultValue": "false", "type": "boolean", "description": "

Shows clear button

\n" }, { "name": "showPreviousMonth", "type": "boolean", "description": "

Shows previous and current month, instead of current and next (dateRangePicker only)

\n" }, { "name": "showTodayButton", "defaultValue": "false", "type": "boolean", "description": "

Shows 'today' button

\n" }, { "name": "showWeekNumbers", "defaultValue": "true", "type": "boolean", "description": "

Allows to hide week numbers in datepicker

\n" }, { "name": "startView", "defaultValue": "day", "type": "BsDatepickerViewMode", "description": "

The view that the datepicker should start in

\n" }, { "name": "todayButtonLabel", "defaultValue": "Today", "type": "string", "description": "

Label for 'today' button

\n" }, { "name": "todayPosition", "defaultValue": "center", "type": "string", "description": "

Positioning of 'today' button

\n" }, { "name": "useUtc", "defaultValue": "false", "type": "boolean", "description": "

sets use UTC date time format

\n" }, { "name": "withTimepicker", "defaultValue": "false", "type": "boolean", "description": "

Shows timepicker under datepicker

\n" } ] }, "BsDaterangepickerInlineDirective": { "fileName": "src/datepicker/bs-daterangepicker-inline.component.ts", "className": "BsDaterangepickerInlineDirective", "description": "", "selector": "bs-daterangepicker-inline", "exportAs": "bsDaterangepickerInline", "inputs": [ { "name": "bsConfig", "type": "Partial", "description": "

Config object for datepicker

\n" }, { "name": "bsValue", "type": "Date[]", "description": "

Initial value of datepicker

\n" }, { "name": "dateCustomClasses", "type": "DatepickerDateCustomClasses[]", "description": "

Date custom classes

\n" }, { "name": "datesDisabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "datesEnabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "daysDisabled", "type": "number[]", "description": "

Disable specific days, e.g. [0,6] will disable all Saturdays and Sundays

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

Indicates whether datepicker is enabled or not

\n" }, { "name": "maxDate", "type": "Date", "description": "

Maximum date which is available for selection

\n" }, { "name": "minDate", "type": "Date", "description": "

Minimum date which is available for selection

\n" } ], "outputs": [ { "name": "bsValueChange", "description": "

Emits when daterangepicker value has been changed

\n" } ], "properties": [], "methods": [ { "name": "setConfig", "description": "

Set config for datepicker

\n", "args": [], "returnType": "void" } ] }, "BsDaterangepickerInlineConfig": { "fileName": "src/datepicker/bs-daterangepicker-inline.config.ts", "className": "BsDaterangepickerInlineConfig", "description": "", "methods": [], "properties": [ { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" } ] }, "BsDaterangepickerInputDirective": { "fileName": "src/datepicker/bs-daterangepicker-input.directive.ts", "className": "BsDaterangepickerInputDirective", "description": "", "selector": "input[bsDaterangepicker]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDaterangepickerDirective": { "fileName": "src/datepicker/bs-daterangepicker.component.ts", "className": "BsDaterangepickerDirective", "description": "", "selector": "[bsDaterangepicker]", "exportAs": "bsDaterangepicker", "inputs": [ { "name": "bsConfig", "type": "Partial", "description": "

Config object for daterangepicker

\n" }, { "name": "bsValue", "type": "Date[]", "description": "

Initial value of daterangepicker

\n" }, { "name": "container", "defaultValue": "body", "type": "string", "description": "

A selector specifying the element the daterangepicker should be appended to.

\n" }, { "name": "dateCustomClasses", "type": "DatepickerDateCustomClasses[]", "description": "

Date custom classes

\n" }, { "name": "datesDisabled", "type": "Date[]", "description": "

Disable specific dates

\n" }, { "name": "datesEnabled", "type": "Date[]", "description": "

Enable specific dates

\n" }, { "name": "daysDisabled", "type": "number[]", "description": "

Disable specific days, e.g. [0,6] will disable all Saturdays and Sundays

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

Indicates whether daterangepicker's content is enabled or not

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Returns whether or not the daterangepicker is currently being shown

\n" }, { "name": "maxDate", "type": "Date", "description": "

Maximum date which is available for selection

\n" }, { "name": "minDate", "type": "Date", "description": "

Minimum date which is available for selection

\n" }, { "name": "outsideClick", "defaultValue": "true", "type": "boolean", "description": "

Close daterangepicker on outside click

\n" }, { "name": "outsideEsc", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "placement", "defaultValue": "bottom", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "

Placement of a daterangepicker. Accepts: "top", "bottom", "left", "right"

\n" }, { "name": "triggers", "defaultValue": "click", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" } ], "outputs": [ { "name": "bsValueChange", "description": "

Emits when daterangepicker value has been changed

\n" }, { "name": "onHidden", "description": "

Emits an event when the daterangepicker is hidden

\n" }, { "name": "onShown", "description": "

Emits an event when the daterangepicker is shown

\n" } ], "properties": [], "methods": [ { "name": "show", "description": "

Opens an element’s datepicker. This is considered a “manual” triggering of\nthe datepicker.

\n", "args": [], "returnType": "void" }, { "name": "setConfig", "description": "

Set config for daterangepicker

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Closes an element’s datepicker. This is considered a “manual” triggering of\nthe datepicker.

\n", "args": [], "returnType": "void" }, { "name": "toggle", "description": "

Toggles an element’s datepicker. This is considered a “manual” triggering\nof the datepicker.

\n", "args": [], "returnType": "void" } ] }, "BsDaterangepickerConfig": { "fileName": "src/datepicker/bs-daterangepicker.config.ts", "className": "BsDaterangepickerConfig", "description": "", "methods": [], "properties": [] }, "BsLocaleService": { "fileName": "src/datepicker/bs-locale.service.ts", "className": "BsLocaleService", "description": "", "methods": [], "properties": [] }, "FlagDaysCalendarOptions": { "fileName": "src/datepicker/engine/flag-days-calendar.ts", "className": "FlagDaysCalendarOptions", "description": "", "methods": [], "properties": [] }, "FlagMonthCalendarOptions": { "fileName": "src/datepicker/engine/flag-months-calendar.ts", "className": "FlagMonthCalendarOptions", "description": "", "methods": [], "properties": [] }, "FlagYearsCalendarOptions": { "fileName": "src/datepicker/engine/flag-years-calendar.ts", "className": "FlagYearsCalendarOptions", "description": "", "methods": [], "properties": [] }, "NavigationViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "NavigationViewModel", "description": "
\n", "methods": [], "properties": [] }, "CalendarCellViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "CalendarCellViewModel", "description": "", "methods": [], "properties": [] }, "DayViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "DayViewModel", "description": "
\n", "methods": [], "properties": [] }, "WeekViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "WeekViewModel", "description": "", "methods": [], "properties": [] }, "DaysCalendarViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "DaysCalendarViewModel", "description": "", "methods": [], "properties": [] }, "MonthsCalendarViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "MonthsCalendarViewModel", "description": "
\n", "methods": [], "properties": [] }, "YearsCalendarViewModel": { "fileName": "src/datepicker/models/index.ts", "className": "YearsCalendarViewModel", "description": "
\n", "methods": [], "properties": [] }, "DaysCalendarModel": { "fileName": "src/datepicker/models/index.ts", "className": "DaysCalendarModel", "description": "
\n", "methods": [], "properties": [] }, "MonthViewOptions": { "fileName": "src/datepicker/models/index.ts", "className": "MonthViewOptions", "description": "
\n", "methods": [], "properties": [] }, "DatepickerFormatOptions": { "fileName": "src/datepicker/models/index.ts", "className": "DatepickerFormatOptions", "description": "
\n", "methods": [], "properties": [] }, "DatepickerRenderOptions": { "fileName": "src/datepicker/models/index.ts", "className": "DatepickerRenderOptions", "description": "", "methods": [], "properties": [] }, "DatepickerDateCustomClasses": { "fileName": "src/datepicker/models/index.ts", "className": "DatepickerDateCustomClasses", "description": "", "methods": [], "properties": [] }, "DatepickerDateTooltipText": { "fileName": "src/datepicker/models/index.ts", "className": "DatepickerDateTooltipText", "description": "", "methods": [], "properties": [] }, "BsNavigationEvent": { "fileName": "src/datepicker/models/index.ts", "className": "BsNavigationEvent", "description": "", "methods": [], "properties": [] }, "BsViewNavigationEvent": { "fileName": "src/datepicker/models/index.ts", "className": "BsViewNavigationEvent", "description": "", "methods": [], "properties": [] }, "CellHoverEvent": { "fileName": "src/datepicker/models/index.ts", "className": "CellHoverEvent", "description": "", "methods": [], "properties": [] }, "BsDatepickerActions": { "fileName": "src/datepicker/reducer/bs-datepicker.actions.ts", "className": "BsDatepickerActions", "description": "", "methods": [], "properties": [] }, "BsDatepickerEffects": { "fileName": "src/datepicker/reducer/bs-datepicker.effects.ts", "className": "BsDatepickerEffects", "description": "", "methods": [ { "name": "setValue", "description": "

setters

\n", "args": [ { "name": "value", "type": "Date" } ], "returnType": "void" }, { "name": "setBindings", "description": "

view to mode bindings

\n", "args": [ { "name": "container", "type": "BsDatepickerAbstractComponent" } ], "returnType": "BsDatepickerEffects" }, { "name": "setEventHandlers", "description": "

event handlers

\n", "args": [ { "name": "container", "type": "BsDatepickerAbstractComponent" } ], "returnType": "BsDatepickerEffects" } ], "properties": [] }, "BsDatepickerViewState": { "fileName": "src/datepicker/reducer/bs-datepicker.state.ts", "className": "BsDatepickerViewState", "description": "", "methods": [], "properties": [] }, "BsDatepickerStore": { "fileName": "src/datepicker/reducer/bs-datepicker.store.ts", "className": "BsDatepickerStore", "description": "", "methods": [], "properties": [] }, "BsCalendarLayoutComponent": { "fileName": "src/datepicker/themes/bs/bs-calendar-layout.component.ts", "className": "BsCalendarLayoutComponent", "description": "", "selector": "bs-calendar-layout", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsCurrentDateViewComponent": { "fileName": "src/datepicker/themes/bs/bs-current-date-view.component.ts", "className": "BsCurrentDateViewComponent", "description": "", "selector": "bs-current-date", "inputs": [ { "name": "title", "type": "string", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "BsCustomDates": { "fileName": "src/datepicker/themes/bs/bs-custom-dates-view.component.ts", "className": "BsCustomDates", "description": "", "methods": [], "properties": [] }, "BsCustomDatesViewComponent": { "fileName": "src/datepicker/themes/bs/bs-custom-dates-view.component.ts", "className": "BsCustomDatesViewComponent", "description": "", "selector": "bs-custom-date-view", "inputs": [ { "name": "customRangeLabel", "type": "string", "description": "" }, { "name": "ranges", "type": "BsCustomDates[]", "description": "" }, { "name": "selectedRange", "type": "Date[]", "description": "" } ], "outputs": [ { "name": "onSelect", "description": "" } ], "properties": [], "methods": [] }, "BsDatepickerContainerComponent": { "fileName": "src/datepicker/themes/bs/bs-datepicker-container.component.ts", "className": "BsDatepickerContainerComponent", "description": "", "selector": "bs-datepicker-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDatepickerDayDecoratorComponent": { "fileName": "src/datepicker/themes/bs/bs-datepicker-day-decorator.directive.ts", "className": "BsDatepickerDayDecoratorComponent", "description": "", "selector": "[bsDatepickerDayDecorator]", "inputs": [ { "name": "day", "type": "DayViewModel", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "BsDatepickerInlineContainerComponent": { "fileName": "src/datepicker/themes/bs/bs-datepicker-inline-container.component.ts", "className": "BsDatepickerInlineContainerComponent", "description": "", "selector": "bs-datepicker-inline-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDatepickerNavigationViewComponent": { "fileName": "src/datepicker/themes/bs/bs-datepicker-navigation-view.component.ts", "className": "BsDatepickerNavigationViewComponent", "description": "", "selector": "bs-datepicker-navigation-view", "inputs": [ { "name": "calendar", "type": "NavigationViewModel", "description": "" } ], "outputs": [ { "name": "onNavigate", "description": "" }, { "name": "onViewMode", "description": "" } ], "properties": [], "methods": [] }, "BsDaterangepickerContainerComponent": { "fileName": "src/datepicker/themes/bs/bs-daterangepicker-container.component.ts", "className": "BsDaterangepickerContainerComponent", "description": "", "selector": "bs-daterangepicker-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDaterangepickerInlineContainerComponent": { "fileName": "src/datepicker/themes/bs/bs-daterangepicker-inline-container.component.ts", "className": "BsDaterangepickerInlineContainerComponent", "description": "", "selector": "bs-daterangepicker-inline-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDaysCalendarViewComponent": { "fileName": "src/datepicker/themes/bs/bs-days-calendar-view.component.ts", "className": "BsDaysCalendarViewComponent", "description": "", "selector": "bs-days-calendar-view", "inputs": [ { "name": "calendar", "type": "DaysCalendarViewModel", "description": "" }, { "name": "options", "type": "DatepickerRenderOptions", "description": "" } ], "outputs": [ { "name": "onHover", "description": "" }, { "name": "onHoverWeek", "description": "" }, { "name": "onNavigate", "description": "" }, { "name": "onSelect", "description": "" }, { "name": "onViewMode", "description": "" } ], "properties": [], "methods": [] }, "BsMonthCalendarViewComponent": { "fileName": "src/datepicker/themes/bs/bs-months-calendar-view.component.ts", "className": "BsMonthCalendarViewComponent", "description": "", "selector": "bs-month-calendar-view", "inputs": [ { "name": "calendar", "type": "MonthsCalendarViewModel", "description": "" } ], "outputs": [ { "name": "onHover", "description": "" }, { "name": "onNavigate", "description": "" }, { "name": "onSelect", "description": "" }, { "name": "onViewMode", "description": "" } ], "properties": [], "methods": [] }, "BsTimepickerViewComponent": { "fileName": "src/datepicker/themes/bs/bs-timepicker-view.component.ts", "className": "BsTimepickerViewComponent", "description": "", "selector": "bs-timepicker", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsYearsCalendarViewComponent": { "fileName": "src/datepicker/themes/bs/bs-years-calendar-view.component.ts", "className": "BsYearsCalendarViewComponent", "description": "", "selector": "bs-years-calendar-view", "inputs": [ { "name": "calendar", "type": "YearsCalendarViewModel", "description": "" } ], "outputs": [ { "name": "onHover", "description": "" }, { "name": "onNavigate", "description": "" }, { "name": "onSelect", "description": "" }, { "name": "onViewMode", "description": "" } ], "properties": [], "methods": [] }, "MatrixOptions": { "fileName": "src/datepicker/utils/matrix-utils.ts", "className": "MatrixOptions", "description": "", "methods": [], "properties": [] }, "BsDropdownContainerComponent": { "fileName": "src/dropdown/bs-dropdown-container.component.ts", "className": "BsDropdownContainerComponent", "description": "", "selector": "bs-dropdown-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDropdownMenuDirective": { "fileName": "src/dropdown/bs-dropdown-menu.directive.ts", "className": "BsDropdownMenuDirective", "description": "", "selector": "[bsDropdownMenu],[dropdownMenu]", "exportAs": "bs-dropdown-menu", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDropdownToggleDirective": { "fileName": "src/dropdown/bs-dropdown-toggle.directive.ts", "className": "BsDropdownToggleDirective", "description": "", "selector": "[bsDropdownToggle],[dropdownToggle]", "exportAs": "bs-dropdown-toggle", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "BsDropdownConfig": { "fileName": "src/dropdown/bs-dropdown.config.ts", "className": "BsDropdownConfig", "description": "

Default dropdown configuration

\n", "methods": [], "properties": [ { "name": "autoClose", "defaultValue": "true", "type": "boolean", "description": "

default dropdown auto closing behavior

\n" }, { "name": "insideClick", "defaultValue": "false", "type": "boolean", "description": "

default dropdown auto closing behavior

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" }, { "name": "stopOnClickPropagation", "defaultValue": "false", "type": "boolean", "description": "

value true of stopOnClickPropagation allows event stopPropagation

\n" } ] }, "BsDropdownDirective": { "fileName": "src/dropdown/bs-dropdown.directive.ts", "className": "BsDropdownDirective", "description": "", "selector": "[bsDropdown], [dropdown]", "exportAs": "bs-dropdown", "inputs": [ { "name": "autoClose", "type": "boolean", "description": "

Indicates that dropdown will be closed on item or document click,\nand after pressing ESC

\n" }, { "name": "container", "type": "string", "description": "

A selector specifying the element the popover should be appended to.

\n" }, { "name": "dropup", "defaultValue": "false", "type": "boolean", "description": "

This attribute indicates that the dropdown should be opened upwards

\n" }, { "name": "insideClick", "type": "boolean", "description": "

This attribute indicates that the dropdown shouldn't close on inside click when autoClose is set to true

\n" }, { "name": "isAnimated", "type": "boolean", "description": "

Indicates that dropdown will be animated

\n" }, { "name": "isDisabled", "type": "boolean", "description": "

Disables dropdown toggle and hides dropdown menu if opened

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Returns whether or not the popover is currently being shown

\n" }, { "name": "placement", "type": "string", "description": "

Placement of a popover. Accepts: "top", "bottom", "left", "right"

\n" }, { "name": "triggers", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" } ], "outputs": [ { "name": "isOpenChange", "description": "

Emits an event when isOpen change

\n" }, { "name": "onHidden", "description": "

Emits an event when the popover is hidden

\n" }, { "name": "onShown", "description": "

Emits an event when the popover is shown

\n" } ], "properties": [ { "name": "autoClose", "type": "boolean", "description": "

Indicates that dropdown will be closed on item or document click,\nand after pressing ESC

\n" }, { "name": "insideClick", "type": "boolean", "description": "

This attribute indicates that the dropdown shouldn't close on inside click when autoClose is set to true

\n" }, { "name": "isAnimated", "type": "boolean", "description": "

Indicates that dropdown will be animated

\n" }, { "name": "isDisabled", "type": "boolean", "description": "

Disables dropdown toggle and hides dropdown menu if opened

\n" } ], "methods": [ { "name": "show", "description": "

Opens an element’s popover. This is considered a “manual” triggering of\nthe popover.

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Closes an element’s popover. This is considered a “manual” triggering of\nthe popover.

\n", "args": [], "returnType": "void" }, { "name": "toggle", "description": "

Toggles an element’s popover. This is considered a “manual” triggering of\nthe popover. With parameter true allows toggling, with parameter false\nonly hides opened dropdown. Parameter usage will be removed in ngx-bootstrap v3

\n", "args": [ { "name": "value", "type": "boolean" } ], "returnType": "void" } ] }, "BsDropdownState": { "fileName": "src/dropdown/bs-dropdown.state.ts", "className": "BsDropdownState", "description": "", "methods": [], "properties": [ { "name": "dropdownMenu", "type": "Promise>", "description": "

Content to be displayed as popover.

\n" } ] }, "ConfigurableFocusTrapConfig": { "fileName": "src/focus-trap/configurable-focus-trap-config.ts", "className": "ConfigurableFocusTrapConfig", "description": "

Configuration for creating a ConfigurableFocusTrap.

\n", "methods": [], "properties": [ { "name": "defer", "defaultValue": "false", "type": "boolean", "description": "

Whether to defer the creation of FocusTrap elements to be\ndone manually by the user. Default is to create them\nautomatically.

\n" } ] }, "ConfigurableFocusTrapFactory": { "fileName": "src/focus-trap/configurable-focus-trap-factory.ts", "className": "ConfigurableFocusTrapFactory", "description": "

Factory that allows easy instantiation of configurable focus traps.

\n", "methods": [ { "name": "create", "description": "

Creates a focus-trapped region around the given element.

\n", "args": [ { "name": "element", "type": "HTMLElement" }, { "name": "config", "type": "ConfigurableFocusTrapConfig" } ], "returnType": "ConfigurableFocusTrap" }, { "name": "create", "description": "

Creates a focus-trapped region around the given element.

\n", "args": [ { "name": "element", "type": "HTMLElement" }, { "name": "deferCaptureElements", "type": "boolean" } ], "returnType": "ConfigurableFocusTrap" }, { "name": "create", "description": "

Creates a focus-trapped region around the given element.

\n", "args": [ { "name": "element", "type": "HTMLElement" }, { "name": "config", "type": "boolean | ConfigurableFocusTrapConfig" } ], "returnType": "ConfigurableFocusTrap" } ], "properties": [] }, "ConfigurableFocusTrap": { "fileName": "src/focus-trap/configurable-focus-trap.ts", "className": "ConfigurableFocusTrap", "description": "

Class that allows for trapping focus within a DOM element.

\n

This class uses a strategy pattern that determines how it traps focus.\nSee FocusTrapInertStrategy.

\n", "methods": [ { "name": "destroy", "description": "

Notifies the FocusTrapManager that this FocusTrap will be destroyed.

\n", "args": [], "returnType": "void" } ], "properties": [ { "name": "enabled", "type": "boolean", "description": "

Whether the FocusTrap is enabled.

\n" } ] }, "EventListenerFocusTrapInertStrategy": { "fileName": "src/focus-trap/event-listener-inert-strategy.ts", "className": "EventListenerFocusTrapInertStrategy", "description": "

Lightweight FocusTrapInertStrategy that adds a document focus event\nlistener to redirect focus back inside the FocusTrap.

\n", "methods": [ { "name": "preventFocus", "description": "

Adds a document event listener that keeps focus inside the FocusTrap.

\n", "args": [ { "name": "focusTrap", "type": "ConfigurableFocusTrap" } ], "returnType": "void" }, { "name": "allowFocus", "description": "

Removes the event listener added in preventFocus.

\n", "args": [ { "name": "focusTrap", "type": "ConfigurableFocusTrap" } ], "returnType": "void" }, { "name": "_trapFocus", "description": "

Refocuses the first element in the FocusTrap if the focus event target was outside\nthe FocusTrap.

\n

This is an event listener callback. The event listener is added in runOutsideAngular,\nso all this code runs outside Angular as well.

\n", "args": [ { "name": "focusTrap", "type": "ConfigurableFocusTrap" }, { "name": "event", "type": "FocusEvent" } ], "returnType": "void" } ], "properties": [ { "name": "_listener", "type": "(e: FocusEvent) => void", "description": "

Focus event handler.

\n" } ] }, "FocusTrapInertStrategy": { "fileName": "src/focus-trap/focus-trap-inert-strategy.ts", "className": "FocusTrapInertStrategy", "description": "

A strategy that dictates how FocusTrap should prevent elements\noutside of the FocusTrap from being focused.

\n", "methods": [ { "name": "preventFocus", "description": "

Makes all elements outside focusTrap unfocusable.

\n", "args": [ { "name": "focusTrap", "type": "FocusTrap" } ], "returnType": "void" }, { "name": "allowFocus", "description": "

Reverts elements made unfocusable by preventFocus to their previous state.

\n", "args": [ { "name": "focusTrap", "type": "FocusTrap" } ], "returnType": "void" } ], "properties": [] }, "ManagedFocusTrap": { "fileName": "src/focus-trap/focus-trap-manager.ts", "className": "ManagedFocusTrap", "description": "

A FocusTrap managed by FocusTrapManager.\nImplemented by ConfigurableFocusTrap to avoid circular dependency.

\n", "methods": [], "properties": [] }, "FocusTrapManager": { "fileName": "src/focus-trap/focus-trap-manager.ts", "className": "FocusTrapManager", "description": "

Injectable that ensures only the most recently enabled FocusTrap is active.

\n", "methods": [ { "name": "register", "description": "

Disables the FocusTrap at the top of the stack, and then pushes\nthe new FocusTrap onto the stack.

\n", "args": [ { "name": "focusTrap", "type": "ManagedFocusTrap" } ], "returnType": "void" }, { "name": "deregister", "description": "

Removes the FocusTrap from the stack, and activates the\nFocusTrap that is the new top of the stack.

\n", "args": [ { "name": "focusTrap", "type": "ManagedFocusTrap" } ], "returnType": "void" } ], "properties": [] }, "FocusTrap": { "fileName": "src/focus-trap/focus-trap.ts", "className": "FocusTrap", "description": "

Class that allows for trapping focus within a DOM element.

\n

This class currently uses a relatively simple approach to focus trapping.\nIt assumes that the tab order is the same as DOM order, which is not necessarily true.\nThings like tabIndex > 0, flex order, and shadow roots can cause the two to misalign.

\n", "methods": [ { "name": "destroy", "description": "

Destroys the focus trap by cleaning up the anchors.

\n", "args": [], "returnType": "void" }, { "name": "attachAnchors", "description": "

Inserts the anchors into the DOM. This is usually done automatically\nin the constructor, but can be deferred for cases like directives with *ngIf.

\n", "args": [], "returnType": "boolean" }, { "name": "focusInitialElementWhenReady", "description": "

Waits for the zone to stabilize, then either focuses the first element that the\nuser specified, or the first tabbable element.

\n", "args": [], "returnType": "Promise" }, { "name": "focusFirstTabbableElementWhenReady", "description": "

Waits for the zone to stabilize, then focuses\nthe first tabbable element within the focus trap region.

\n", "args": [], "returnType": "Promise" }, { "name": "focusLastTabbableElementWhenReady", "description": "

Waits for the zone to stabilize, then focuses\nthe last tabbable element within the focus trap region.

\n", "args": [], "returnType": "Promise" }, { "name": "_getRegionBoundary", "description": "

Get the specified boundary element of the trapped region.

\n", "args": [ { "name": "bound", "type": "\"start\" | \"end\"" } ], "returnType": "HTMLElement" }, { "name": "focusInitialElement", "description": "

Focuses the element that should be focused when the focus trap is initialized.

\n", "args": [], "returnType": "boolean" }, { "name": "focusFirstTabbableElement", "description": "

Focuses the first tabbable element within the focus trap region.

\n", "args": [], "returnType": "boolean" }, { "name": "focusLastTabbableElement", "description": "

Focuses the last tabbable element within the focus trap region.

\n", "args": [], "returnType": "boolean" }, { "name": "hasAttached", "description": "

Checks whether the focus trap has successfully been attached.

\n", "args": [], "returnType": "boolean" }, { "name": "_getFirstTabbableElement", "description": "

Get the first tabbable element from a DOM subtree (inclusive).

\n", "args": [ { "name": "root", "type": "HTMLElement" } ], "returnType": "HTMLElement" }, { "name": "_getLastTabbableElement", "description": "

Get the last tabbable element from a DOM subtree (inclusive).

\n", "args": [ { "name": "root", "type": "HTMLElement" } ], "returnType": "HTMLElement" }, { "name": "_createAnchor", "description": "

Creates an anchor element.

\n", "args": [], "returnType": "HTMLElement" }, { "name": "_toggleAnchorTabIndex", "description": "

Toggles the tabindex of an anchor, based on the enabled state of the focus trap.

\n", "args": [ { "name": "isEnabled", "type": "boolean" }, { "name": "anchor", "type": "HTMLElement" } ], "returnType": "void" }, { "name": "toggleAnchors", "description": "

Toggles thetabindex of both anchors to either trap Tab focus or allow it to escape.

\n", "args": [ { "name": "enabled", "type": "boolean" } ], "returnType": "void" }, { "name": "_executeOnStable", "description": "

Executes a function when the zone is stable.

\n", "args": [ { "name": "fn", "type": "() => any" } ], "returnType": "void" } ], "properties": [ { "name": "enabled", "type": "boolean", "description": "

Whether the focus trap is active.

\n" } ] }, "FocusTrapFactory": { "fileName": "src/focus-trap/focus-trap.ts", "className": "FocusTrapFactory", "description": "

Factory that allows easy instantiation of focus traps.

\n", "methods": [ { "name": "create", "description": "

Creates a focus-trapped region around the given element.

\n", "args": [ { "name": "element", "type": "HTMLElement" }, { "name": "deferCaptureElements", "type": "boolean" } ], "returnType": "FocusTrap" } ], "properties": [] }, "FocusTrapDirective": { "fileName": "src/focus-trap/focus-trap.ts", "className": "FocusTrapDirective", "description": "

Directive for trapping focus within a region.

\n", "selector": "[focusTrap]", "exportAs": "focusTrap", "inputs": [ { "name": "cdkTrapFocus", "type": "boolean", "description": "

Whether the focus trap is active.

\n" }, { "name": "cdkTrapFocusAutoCapture", "type": "boolean", "description": "

Whether the directive should automatically move focus into the trapped region upon\ninitialization and return focus to the previous activeElement upon destruction.

\n" } ], "outputs": [], "properties": [ { "name": "_previouslyFocusedElement", "type": "HTMLElement", "description": "

Previously focused element to restore focus to upon destroy when using autoCapture.

\n" }, { "name": "focusTrap", "type": "FocusTrap", "description": "

Underlying FocusTrap instance.

\n" } ], "methods": [] }, "IsFocusableConfig": { "fileName": "src/focus-trap/interactivity-checker.ts", "className": "IsFocusableConfig", "description": "

Configuration for the isFocusable method.

\n", "methods": [], "properties": [ { "name": "ignoreVisibility", "defaultValue": "false", "type": "boolean", "description": "

Whether to count an element as focusable even if it is not currently visible.

\n" } ] }, "InteractivityChecker": { "fileName": "src/focus-trap/interactivity-checker.ts", "className": "InteractivityChecker", "description": "

Utility for checking the interactivity of an element, such as whether is is focusable or\ntabbable.

\n", "methods": [ { "name": "isDisabled", "description": "

Gets whether an element is disabled.

\n", "args": [ { "name": "element", "type": "HTMLElement" } ], "returnType": "boolean" }, { "name": "isVisible", "description": "

Gets whether an element is visible for the purposes of interactivity.

\n

This will capture states like display: none and visibility: hidden, but not things like\nbeing clipped by an overflow: hidden parent or being outside the viewport.

\n", "args": [ { "name": "element", "type": "HTMLElement" } ], "returnType": "boolean" }, { "name": "isTabbable", "description": "

Gets whether an element can be reached via Tab key.\nAssumes that the element has already been checked with isFocusable.

\n", "args": [ { "name": "element", "type": "HTMLElement" } ], "returnType": "boolean" }, { "name": "isFocusable", "description": "

Gets whether an element can be focused by the user.

\n", "args": [ { "name": "element", "type": "HTMLElement" }, { "name": "config", "type": "IsFocusableConfig" } ], "returnType": "boolean" } ], "properties": [] }, "Platform": { "fileName": "src/focus-trap/platform.ts", "className": "Platform", "description": "

Service to detect the current platform by comparing the userAgent strings and\nchecking browser-specific global properties.

\n", "methods": [], "properties": [ { "name": "ANDROID", "type": "boolean", "description": "

Whether the current platform is Android.

\n" }, { "name": "BLINK", "type": "boolean", "description": "

Whether the current rendering engine is Blink.

\n" }, { "name": "EDGE", "type": "boolean", "description": "

Whether the current browser is Microsoft Edge.

\n" }, { "name": "FIREFOX", "type": "boolean", "description": "

Whether the current browser is Firefox.

\n" }, { "name": "IOS", "type": "boolean", "description": "

Whether the current platform is Apple iOS.

\n" }, { "name": "isBrowser", "type": "boolean", "description": "

Whether the Angular application is being rendered in the browser.

\n" }, { "name": "SAFARI", "type": "boolean", "description": "

Whether the current browser is Safari.

\n" }, { "name": "TRIDENT", "type": "boolean", "description": "

Whether the current rendering engine is Microsoft Trident.

\n" }, { "name": "WEBKIT", "type": "boolean", "description": "

Whether the current rendering engine is WebKit.

\n" } ] }, "Action": { "fileName": "src/mini-ngrx/public_api.ts", "className": "Action", "description": "", "methods": [], "properties": [] }, "BsModalRef": { "fileName": "src/modal/bs-modal-ref.service.ts", "className": "BsModalRef", "description": "", "methods": [], "properties": [ { "name": "content", "type": "T", "description": "

Reference to a component inside the modal. Null if modal's been created with TemplateRef

\n" }, { "name": "hide", "type": "() => void", "description": "

Hides the modal

\n" }, { "name": "id", "type": "string | number", "description": "

Allow user to ID for the modal. Otherwise, a unique number will be given

\n" }, { "name": "onHidden", "type": "EventEmitter", "description": "

Event that is fired when the modal behind the ref finishes hiding

\n" }, { "name": "onHide", "type": "EventEmitter", "description": "

Event that is fired when the modal behind the ref starts hiding

\n" }, { "name": "setClass", "type": "(newClass: string) => void", "description": "

Sets new class to modal window

\n" } ] }, "BsModalService": { "fileName": "src/modal/bs-modal.service.ts", "className": "BsModalService", "description": "", "methods": [ { "name": "show", "description": "

Shows a modal

\n", "args": [ { "name": "content", "type": "string | TemplateRef | (new (...args: any[]) => T)" }, { "name": "config", "type": "ModalOptions" } ], "returnType": "BsModalRef" } ], "properties": [] }, "ModalBackdropComponent": { "fileName": "src/modal/modal-backdrop.component.ts", "className": "ModalBackdropComponent", "description": "

This component will be added as background layout for modals if enabled

\n", "selector": "bs-modal-backdrop", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "ModalContainerComponent": { "fileName": "src/modal/modal-container.component.ts", "className": "ModalContainerComponent", "description": "", "selector": "modal-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "ModalOptions": { "fileName": "src/modal/modal-options.class.ts", "className": "ModalOptions", "description": "", "methods": [], "properties": [ { "name": "animated", "type": "boolean", "description": "

Toggle animation

\n" }, { "name": "ariaDescribedby", "type": "string", "description": "

aria-describedby attribute value to set on the modal window

\n" }, { "name": "ariaLabelledBy", "type": "string", "description": "

aria-labelledby attribute value to set on the modal window

\n" }, { "name": "backdrop", "type": "boolean | \"static\"", "description": "

Includes a modal-backdrop element. Alternatively,\nspecify static for a backdrop which doesn't close the modal on click.

\n" }, { "name": "class", "type": "string", "description": "

Css class for opened modal

\n" }, { "name": "closeInterceptor", "type": "CloseInterceptorFn", "description": "

Function to intercept the closure

\n" }, { "name": "id", "type": "string | number", "description": "

Allow user to ID for the modal. Otherwise, a unique number will be given

\n" }, { "name": "ignoreBackdropClick", "type": "boolean", "description": "

Ignore the backdrop click

\n" }, { "name": "initialState", "type": "Partial", "description": "

Modal data

\n" }, { "name": "keyboard", "type": "boolean", "description": "

Closes the modal when escape key is pressed.

\n" }, { "name": "providers", "type": "StaticProvider[]", "description": "

Modal providers

\n" }, { "name": "show", "type": "boolean", "description": "

Shows the modal when initialized.

\n" } ] }, "ModalDirective": { "fileName": "src/modal/modal.directive.ts", "className": "ModalDirective", "description": "

Mark any code with directive to show it's content in modal

\n", "selector": "[bsModal]", "exportAs": "bs-modal", "inputs": [ { "name": "closeInterceptor", "type": "CloseInterceptorFn", "description": "

allows to provide a callback to intercept the closure of the modal

\n" }, { "name": "config", "type": "ModalOptions>", "description": "

allows to set modal configuration via element property

\n" } ], "outputs": [ { "name": "onHidden", "description": "

This event is fired when the modal has finished being\nhidden from the user (will wait for CSS transitions to complete).

\n" }, { "name": "onHide", "description": "

This event is fired immediately when\nthe hide instance method has been called.

\n" }, { "name": "onShow", "description": "

This event fires immediately when the show instance method is called.

\n" }, { "name": "onShown", "description": "

This event is fired when the modal has been made visible to the user\n(will wait for CSS transitions to complete)

\n" } ], "properties": [ { "name": "config", "type": "ModalOptions>", "description": "

allows to set modal configuration via element property

\n" }, { "name": "dismissReason", "type": "string", "description": "

This field contains last dismiss reason.\nPossible values: backdrop-click, esc and id: number\n(if modal was closed by direct call of .hide()).

\n" } ], "methods": [ { "name": "toggle", "description": "

Allows to manually toggle modal visibility

\n", "args": [], "returnType": "void" }, { "name": "show", "description": "

Allows to manually open modal

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Check if we can close the modal

\n", "args": [ { "name": "event", "type": "Event" } ], "returnType": "void" }, { "name": "_hide", "description": "

Manually close modal

\n", "args": [], "returnType": "void" }, { "name": "showElement", "description": "

Show dialog

\n", "args": [], "returnType": "void" }, { "name": "focusOtherModal", "description": "

Events tricks

\n", "args": [], "returnType": "void" } ] }, "ClassName": { "fileName": "src/modal/models/index.ts", "className": "ClassName", "description": "", "methods": [], "properties": [] }, "Selector": { "fileName": "src/modal/models/index.ts", "className": "Selector", "description": "", "methods": [], "properties": [] }, "TransitionDurations": { "fileName": "src/modal/models/index.ts", "className": "TransitionDurations", "description": "", "methods": [], "properties": [] }, "DismissReasons": { "fileName": "src/modal/models/index.ts", "className": "DismissReasons", "description": "", "methods": [], "properties": [] }, "ConfigModel": { "fileName": "src/pagination/models/index.ts", "className": "ConfigModel", "description": "", "methods": [], "properties": [] }, "PagesModel": { "fileName": "src/pagination/models/index.ts", "className": "PagesModel", "description": "

Contain information about the page

\n", "methods": [], "properties": [ { "name": "active", "type": "boolean", "description": "

If true, then this is the current page

\n" }, { "name": "number", "type": "number", "description": "

Page number

\n" }, { "name": "text", "type": "string", "description": "

Text, which is displayed in the link

\n" } ] }, "PagerModel": { "fileName": "src/pagination/models/index.ts", "className": "PagerModel", "description": "", "methods": [], "properties": [] }, "PaginationLinkContext": { "fileName": "src/pagination/models/index.ts", "className": "PaginationLinkContext", "description": "

A context for the

\n
    \n
  • customPageTemplate
  • \n
  • customNextTemplate
  • \n
  • customPreviousTemplate
  • \n
  • customFirstTemplate
  • \n
  • customLastTemplate\ninputs for link templates in case you want to override one
  • \n
\n", "methods": [], "properties": [ { "name": "currentPage", "type": "number", "description": "

The currently selected page number

\n" }, { "name": "disabled", "type": "boolean", "description": "

If true, the current link is disabled

\n" } ] }, "PaginationNumberLinkContext": { "fileName": "src/pagination/models/index.ts", "className": "PaginationNumberLinkContext", "description": "

A context for the pageTemplate inputs for link template

\n", "methods": [], "properties": [ { "name": "$implicit", "type": "PagesModel", "description": "

Contain the page information

\n" } ] }, "PagerComponent": { "fileName": "src/pagination/pager.component.ts", "className": "PagerComponent", "description": "", "selector": "pager", "inputs": [ { "name": "align", "defaultValue": "false", "type": "boolean", "description": "

if true aligns each link to the sides of pager

\n" }, { "name": "boundaryLinks", "defaultValue": "false", "type": "boolean", "description": "

if false first and last buttons will be hidden

\n" }, { "name": "directionLinks", "defaultValue": "true", "type": "boolean", "description": "

if false previous and next buttons will be hidden

\n" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "

if true pagination component will be disabled

\n" }, { "name": "firstText", "defaultValue": "First", "type": "string", "description": "

first button text

\n" }, { "name": "itemsPerPage", "type": "number", "description": "

maximum number of items per page. If value less than 1 will display all items on one page

\n" }, { "name": "lastText", "defaultValue": "Last", "type": "string", "description": "

last button text

\n" }, { "name": "maxSize", "type": "number", "description": "

limit number for page links in pager

\n" }, { "name": "nextText", "defaultValue": "Next »", "type": "string", "description": "

next button text

\n" }, { "name": "pageBtnClass", "type": "string", "description": "

add class to

\n" }, { "name": "previousText", "defaultValue": "« Previous", "type": "string", "description": "

previous button text

\n" }, { "name": "rotate", "defaultValue": "true", "type": "boolean", "description": "

if true current page will in the middle of pages list

\n" }, { "name": "totalItems", "type": "number", "description": "

total number of items in all pages

\n" } ], "outputs": [ { "name": "numPages", "description": "

fired when total pages count changes, $event:number equals to total pages count

\n" }, { "name": "pageChanged", "description": "

fired when page was changed, $event:{page, itemsPerPage} equals to\nobject with current page index and number of items per page

\n" } ], "properties": [], "methods": [] }, "PageChangedEvent": { "fileName": "src/pagination/pagination.component.ts", "className": "PageChangedEvent", "description": "", "methods": [], "properties": [] }, "PaginationComponent": { "fileName": "src/pagination/pagination.component.ts", "className": "PaginationComponent", "description": "", "selector": "pagination", "inputs": [ { "name": "align", "defaultValue": "true", "type": "boolean", "description": "

if true aligns each link to the sides of pager

\n" }, { "name": "boundaryLinks", "defaultValue": "false", "type": "boolean", "description": "

if false first and last buttons will be hidden

\n" }, { "name": "customFirstTemplate", "type": "TemplateRef", "description": "

custom template for first link

\n" }, { "name": "customLastTemplate", "type": "TemplateRef", "description": "

custom template for last link

\n" }, { "name": "customNextTemplate", "type": "TemplateRef", "description": "

custom template for next link

\n" }, { "name": "customPageTemplate", "type": "TemplateRef", "description": "

custom template for page link

\n" }, { "name": "customPreviousTemplate", "type": "TemplateRef", "description": "

custom template for previous link

\n" }, { "name": "directionLinks", "defaultValue": "true", "type": "boolean", "description": "

if false previous and next buttons will be hidden

\n" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "

if true pagination component will be disabled

\n" }, { "name": "firstText", "type": "string", "description": "

first button text

\n" }, { "name": "itemsPerPage", "type": "number", "description": "

maximum number of items per page. If value less than 1 will display all items on one page

\n" }, { "name": "lastText", "type": "string", "description": "

last button text

\n" }, { "name": "maxSize", "type": "number", "description": "

limit number for page links in pager

\n" }, { "name": "nextText", "type": "string", "description": "

next button text

\n" }, { "name": "pageBtnClass", "type": "string", "description": "

add class to

\n" }, { "name": "previousText", "type": "string", "description": "

previous button text

\n" }, { "name": "rotate", "defaultValue": "true", "type": "boolean", "description": "

if true current page will in the middle of pages list

\n" }, { "name": "totalItems", "type": "number", "description": "

total number of items in all pages

\n" } ], "outputs": [ { "name": "numPages", "description": "

fired when total pages count changes, $event:number equals to total pages count

\n" }, { "name": "pageChanged", "description": "

fired when page was changed, $event:{page, itemsPerPage} equals to object\nwith current page index and number of items per page

\n" } ], "properties": [], "methods": [] }, "PaginationConfig": { "fileName": "src/pagination/pagination.config.ts", "className": "PaginationConfig", "description": "

Provides default values for Pagination and pager components

\n", "methods": [], "properties": [] }, "PopoverContainerComponent": { "fileName": "src/popover/popover-container.component.ts", "className": "PopoverContainerComponent", "description": "", "selector": "popover-container", "inputs": [ { "name": "placement", "type": "AvailbleBSPositions", "description": "" }, { "name": "title", "type": "string", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "PopoverConfig": { "fileName": "src/popover/popover.config.ts", "className": "PopoverConfig", "description": "

Configuration service for the Popover directive.\nYou can inject this service, typically in your root component, and customize\nthe values of its properties in order to provide default values for all the\npopovers used in the application.

\n", "methods": [], "properties": [ { "name": "adaptivePosition", "defaultValue": "true", "type": "boolean", "description": "

sets disable adaptive position

\n" }, { "name": "container", "type": "string", "description": "

A selector specifying the element the popover should be appended to.

\n" }, { "name": "delay", "defaultValue": "0", "type": "number", "description": "

delay before showing the tooltip

\n" }, { "name": "placement", "defaultValue": "top", "type": "string", "description": "

Placement of a popover. Accepts: "top", "bottom", "left", "right", "auto"

\n" }, { "name": "triggers", "defaultValue": "click", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" } ] }, "PopoverDirective": { "fileName": "src/popover/popover.directive.ts", "className": "PopoverDirective", "description": "

A lightweight, extensible directive for fancy popover creation.

\n", "selector": "[popover]", "exportAs": "bs-popover", "inputs": [ { "name": "adaptivePosition", "defaultValue": "true", "type": "boolean", "description": "

sets disable adaptive position

\n" }, { "name": "container", "type": "string", "description": "

A selector specifying the element the popover should be appended to.

\n" }, { "name": "containerClass", "type": "string", "description": "

Css class for popover container

\n" }, { "name": "delay", "defaultValue": "0", "type": "number", "description": "

Delay before showing the tooltip

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Returns whether or not the popover is currently being shown

\n" }, { "name": "outsideClick", "defaultValue": "false", "type": "boolean", "description": "

Close popover on outside click

\n" }, { "name": "placement", "defaultValue": "top", "type": "AvailbleBSPositions", "description": "

Placement of a popover. Accepts: "top", "bottom", "left", "right"

\n" }, { "name": "popover", "type": "string | TemplateRef", "description": "

Content to be displayed as popover.

\n" }, { "name": "popoverContext", "type": "any", "description": "

Context to be used if popover is a template.

\n" }, { "name": "popoverTitle", "type": "string", "description": "

Title of a popover.

\n" }, { "name": "triggers", "defaultValue": "click", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" }, { "name": "boundariesElement", "type": "\"viewport\" | \"scrollParent\" | \"window\"", "description": "" } ], "outputs": [ { "name": "onHidden", "description": "

Emits an event when the popover is hidden

\n" }, { "name": "onShown", "description": "

Emits an event when the popover is shown

\n" } ], "properties": [ { "name": "popoverId", "type": "number", "description": "

unique id popover - use for aria-describedby

\n" } ], "methods": [ { "name": "setAriaDescribedBy", "description": "

Set attribute aria-describedBy for element directive and\nset id for the popover

\n", "args": [], "returnType": "void" }, { "name": "show", "description": "

Opens an element’s popover. This is considered a “manual” triggering of\nthe popover.

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Closes an element’s popover. This is considered a “manual” triggering of\nthe popover.

\n", "args": [], "returnType": "void" }, { "name": "toggle", "description": "

Toggles an element’s popover. This is considered a “manual” triggering of\nthe popover.

\n", "args": [], "returnType": "void" } ] }, "Offsets": { "fileName": "src/positioning/models/index.ts", "className": "Offsets", "description": "", "methods": [], "properties": [] }, "Data": { "fileName": "src/positioning/models/index.ts", "className": "Data", "description": "", "methods": [], "properties": [] }, "Options": { "fileName": "src/positioning/models/index.ts", "className": "Options", "description": "", "methods": [], "properties": [] }, "PositioningOptions": { "fileName": "src/positioning/positioning.service.ts", "className": "PositioningOptions", "description": "", "methods": [], "properties": [ { "name": "appendToBody", "type": "boolean", "description": "

If true component will be attached to body

\n" }, { "name": "attachment", "type": "string", "description": "

A string of the form 'vert-attachment horiz-attachment' or 'placement'

\n
    \n
  • placement can be "top", "bottom", "left", "right"\nnot yet supported:
  • \n
  • vert-attachment can be any of 'top', 'middle', 'bottom'
  • \n
  • horiz-attachment can be any of 'left', 'center', 'right'
  • \n
\n" }, { "name": "element", "type": "string | HTMLElement | ElementRef", "description": "

The DOM element, ElementRef, or a selector string of an element which will be moved

\n" }, { "name": "offset", "type": "string", "description": "

A string of the form 'vert-offset horiz-offset'

\n
    \n
  • vert-offset and horiz-offset can be of the form "20px" or "55%"
  • \n
\n" }, { "name": "target", "type": "string | HTMLElement | ElementRef", "description": "

The DOM element, ElementRef, or a selector string of an element which the element will be attached to

\n" }, { "name": "targetAttachment", "type": "string", "description": "

A string similar to attachment. The one difference is that, if it's not provided,\ntargetAttachment will assume the mirror image of attachment.

\n" }, { "name": "targetOffset", "type": "string", "description": "

A string similar to offset, but referring to the offset of the target

\n" } ] }, "PositioningService": { "fileName": "src/positioning/positioning.service.ts", "className": "PositioningService", "description": "", "methods": [], "properties": [] }, "BarComponent": { "fileName": "src/progressbar/bar.component.ts", "className": "BarComponent", "description": "", "selector": "bar", "inputs": [ { "name": "animate", "defaultValue": "false", "type": "boolean", "description": "

if true changing value of progress bar will be animated

\n" }, { "name": "max", "defaultValue": "100", "type": "number", "description": "

maximum total value of progress element

\n" }, { "name": "striped", "defaultValue": "false", "type": "boolean", "description": "

If true, striped classes are applied

\n" }, { "name": "type", "defaultValue": "info", "type": "ProgressbarType", "description": "

provide one of the four supported contextual classes: success, info, warning, danger

\n" }, { "name": "value", "defaultValue": "0", "type": "number", "description": "

current value of progress bar

\n" } ], "outputs": [], "properties": [], "methods": [] }, "BarValue": { "fileName": "src/progressbar/progressbar-type.interface.ts", "className": "BarValue", "description": "", "methods": [], "properties": [] }, "ProgressbarComponent": { "fileName": "src/progressbar/progressbar.component.ts", "className": "ProgressbarComponent", "description": "", "selector": "progressbar", "inputs": [ { "name": "animate", "defaultValue": "false", "type": "boolean", "description": "

if true changing value of progress bar will be animated

\n" }, { "name": "max", "defaultValue": "100", "type": "number", "description": "

maximum total value of progress element

\n" }, { "name": "striped", "defaultValue": "false", "type": "boolean", "description": "

If true, striped classes are applied

\n" }, { "name": "type", "type": "ProgressbarType", "description": "

provide one of the four supported contextual classes: success, info, warning, danger

\n" }, { "name": "value", "type": "number | BarValue[]", "description": "

current value of progress bar. Could be a number or array of objects\nlike {"value":15,"type":"info","label":"15 %"}

\n" } ], "outputs": [], "properties": [], "methods": [] }, "ProgressbarConfig": { "fileName": "src/progressbar/progressbar.config.ts", "className": "ProgressbarConfig", "description": "", "methods": [], "properties": [ { "name": "animate", "defaultValue": "false", "type": "boolean", "description": "

if true changing value of progress bar will be animated

\n" }, { "name": "max", "defaultValue": "100", "type": "number", "description": "

maximum total value of progress element

\n" } ] }, "RatingResults": { "fileName": "src/rating/models/index.ts", "className": "RatingResults", "description": "", "methods": [], "properties": [] }, "RatingComponent": { "fileName": "src/rating/rating.component.ts", "className": "RatingComponent", "description": "", "selector": "rating", "inputs": [ { "name": "customTemplate", "type": "TemplateRef", "description": "

custom template for icons

\n" }, { "name": "max", "defaultValue": "5", "type": "number", "description": "

number of icons

\n" }, { "name": "readonly", "defaultValue": "false", "type": "boolean", "description": "

if true will not react on any user events

\n" }, { "name": "titles", "type": "string[]", "description": "

array of icons titles, default: (["one", "two", "three", "four", "five"])

\n" } ], "outputs": [ { "name": "onHover", "description": "

fired when icon selected, $event:number equals to selected rating

\n" }, { "name": "onLeave", "description": "

fired when icon selected, $event:number equals to previous rating value

\n" } ], "properties": [ { "name": "ariaLabel", "defaultValue": "rating", "type": "string", "description": "

aria label for rating

\n" } ], "methods": [] }, "RatingConfig": { "fileName": "src/rating/rating.config.ts", "className": "RatingConfig", "description": "

Default values provider for rating

\n", "methods": [], "properties": [ { "name": "ariaLabel", "defaultValue": "rating", "type": "string", "description": "

aria label for rating

\n" } ] }, "Schema": { "fileName": "src/schematics/src/ng-add/schema.ts", "className": "Schema", "description": "", "methods": [], "properties": [] }, "availablePaths": { "fileName": "src/schematics/src/utils/addStyles.ts", "className": "availablePaths", "description": "", "methods": [], "properties": [] }, "DraggableItemService": { "fileName": "src/sortable/draggable-item.service.ts", "className": "DraggableItemService", "description": "", "methods": [], "properties": [] }, "DraggableItem": { "fileName": "src/sortable/draggable-item.ts", "className": "DraggableItem", "description": "", "methods": [], "properties": [] }, "SortableComponent": { "fileName": "src/sortable/sortable.component.ts", "className": "SortableComponent", "description": "", "selector": "bs-sortable", "exportAs": "bs-sortable", "inputs": [ { "name": "fieldName", "type": "string", "description": "

field name if input array consists of objects

\n" }, { "name": "itemActiveClass", "type": "string", "description": "

class name for active item

\n" }, { "name": "itemActiveStyle", "type": "Record", "description": "

style object for active item

\n" }, { "name": "itemClass", "type": "string", "description": "

class name for item

\n" }, { "name": "itemStyle", "type": "Record", "description": "

style object for item

\n" }, { "name": "itemTemplate", "type": "TemplateRef", "description": "

used to specify a custom item template. Template variables: item and index;

\n" }, { "name": "placeholderClass", "type": "string", "description": "

class name for placeholder

\n" }, { "name": "placeholderItem", "type": "string", "description": "

placeholder item which will be shown if collection is empty

\n" }, { "name": "placeholderStyle", "type": "Record", "description": "

style object for placeholder

\n" }, { "name": "wrapperClass", "type": "string", "description": "

class name for items wrapper

\n" }, { "name": "wrapperStyle", "type": "Record", "description": "

style object for items wrapper

\n" } ], "outputs": [ { "name": "onChange", "description": "

fired on array change (reordering, insert, remove), same as ngModelChange.\nReturns new items collection as a payload.

\n" } ], "properties": [], "methods": [] }, "SortableItem": { "fileName": "src/sortable/sortable.component.ts", "className": "SortableItem", "description": "", "methods": [], "properties": [] }, "NgTranscludeDirective": { "fileName": "src/tabs/ng-transclude.directive.ts", "className": "NgTranscludeDirective", "description": "", "selector": "[ngTransclude]", "inputs": [ { "name": "ngTransclude", "type": "TemplateRef", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "TabHeadingDirective": { "fileName": "src/tabs/tab-heading.directive.ts", "className": "TabHeadingDirective", "description": "

Should be used to mark element as a template for tab heading

\n", "selector": "[tabHeading]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "TabDirective": { "fileName": "src/tabs/tab.directive.ts", "className": "TabDirective", "description": "", "selector": "tab, [tab]", "exportAs": "tab", "inputs": [ { "name": "active", "type": "boolean", "description": "

tab active state toggle

\n" }, { "name": "customClass", "type": "string", "description": "

if set, will be added to the tab's class attribute. Multiple classes are supported.

\n" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "

if true tab can not be activated

\n" }, { "name": "heading", "type": "string", "description": "

tab header text

\n" }, { "name": "id", "type": "string", "description": "

tab id. The same id with suffix '-link' will be added to the corresponding <li> element

\n" }, { "name": "removable", "defaultValue": "false", "type": "boolean", "description": "

if true tab can be removable, additional button will appear

\n" } ], "outputs": [ { "name": "deselect", "description": "

fired when tab became inactive, $event:Tab equals to deselected instance of Tab component

\n" }, { "name": "removed", "description": "

fired before tab will be removed, $event:Tab equals to instance of removed tab

\n" }, { "name": "selectTab", "description": "

fired when tab became active, $event:Tab equals to selected instance of Tab component

\n" } ], "properties": [], "methods": [] }, "TabsetComponent": { "fileName": "src/tabs/tabset.component.ts", "className": "TabsetComponent", "description": "", "selector": "tabset", "inputs": [ { "name": "justified", "type": "boolean", "description": "

if true tabs fill the container and have a consistent width

\n" }, { "name": "type", "type": "string", "description": "

navigation context class: 'tabs' or 'pills'

\n" }, { "name": "vertical", "type": "boolean", "description": "

if true tabs will be placed vertically

\n" } ], "outputs": [], "properties": [ { "name": "ariaLabel", "defaultValue": "Tabs", "type": "string", "description": "

aria label for tab list

\n" } ], "methods": [] }, "TabsetConfig": { "fileName": "src/tabs/tabset.config.ts", "className": "TabsetConfig", "description": "", "methods": [], "properties": [ { "name": "ariaLabel", "defaultValue": "Tabs", "type": "string", "description": "

aria label for tab list

\n" }, { "name": "isKeysAllowed", "defaultValue": "true", "type": "boolean", "description": "

provides possibility to set keyNavigations enable or disable, by default is enable

\n" }, { "name": "type", "defaultValue": "tabs", "type": "string", "description": "

provides default navigation context class: 'tabs' or 'pills'

\n" } ] }, "ControlValueAccessorModel": { "fileName": "src/timepicker/models/index.ts", "className": "ControlValueAccessorModel", "description": "", "methods": [], "properties": [] }, "TimepickerActions": { "fileName": "src/timepicker/reducer/timepicker.actions.ts", "className": "TimepickerActions", "description": "", "methods": [], "properties": [] }, "TimepickerState": { "fileName": "src/timepicker/reducer/timepicker.reducer.ts", "className": "TimepickerState", "description": "", "methods": [], "properties": [] }, "TimepickerStore": { "fileName": "src/timepicker/reducer/timepicker.store.ts", "className": "TimepickerStore", "description": "", "methods": [], "properties": [] }, "TimepickerComponent": { "fileName": "src/timepicker/timepicker.component.ts", "className": "TimepickerComponent", "description": "", "selector": "timepicker", "inputs": [ { "name": "arrowkeys", "defaultValue": "true", "type": "boolean", "description": "

if true the values of hours and minutes can be changed using the up/down arrow keys on the keyboard

\n" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "

if true hours and minutes fields will be disabled

\n" }, { "name": "hoursPlaceholder", "defaultValue": "HH", "type": "string", "description": "

placeholder for hours field in timepicker

\n" }, { "name": "hourStep", "defaultValue": "1", "type": "number", "description": "

hours change step

\n" }, { "name": "max", "type": "Date", "description": "

maximum time user can select

\n" }, { "name": "meridians", "type": "string[]", "description": "

meridian labels based on locale

\n" }, { "name": "min", "type": "Date", "description": "

minimum time user can select

\n" }, { "name": "minutesPlaceholder", "defaultValue": "MM", "type": "string", "description": "

placeholder for minutes field in timepicker

\n" }, { "name": "minuteStep", "defaultValue": "5", "type": "number", "description": "

minutes change step

\n" }, { "name": "mousewheel", "defaultValue": "true", "type": "boolean", "description": "

if true scroll inside hours and minutes inputs will change time

\n" }, { "name": "readonlyInput", "defaultValue": "false", "type": "boolean", "description": "

if true hours and minutes fields will be readonly

\n" }, { "name": "secondsPlaceholder", "defaultValue": "SS", "type": "string", "description": "

placeholder for seconds field in timepicker

\n" }, { "name": "secondsStep", "defaultValue": "10", "type": "number", "description": "

seconds change step

\n" }, { "name": "showMeridian", "defaultValue": "true", "type": "boolean", "description": "

if true meridian button will be shown

\n" }, { "name": "showMinutes", "defaultValue": "true", "type": "boolean", "description": "

show minutes in timepicker

\n" }, { "name": "showSeconds", "defaultValue": "false", "type": "boolean", "description": "

show seconds in timepicker

\n" }, { "name": "showSpinners", "defaultValue": "true", "type": "boolean", "description": "

if true spinner arrows above and below the inputs will be shown

\n" } ], "outputs": [ { "name": "isValid", "description": "

emits true if value is a valid date

\n" }, { "name": "meridianChange", "description": "

emits value of meridian

\n" } ], "properties": [], "methods": [] }, "TimepickerConfig": { "fileName": "src/timepicker/timepicker.config.ts", "className": "TimepickerConfig", "description": "

Provides default configuration values for timepicker

\n", "methods": [], "properties": [ { "name": "allowEmptyTime", "defaultValue": "false", "type": "boolean", "description": "

if true emptyTime is not marked as invalid

\n" }, { "name": "ariaLabelHours", "defaultValue": "hours", "type": "string", "description": "

hours aria label

\n" }, { "name": "ariaLabelMinutes", "defaultValue": "minutes", "type": "string", "description": "

minutes aria label

\n" }, { "name": "ariaLabelSeconds", "defaultValue": "seconds", "type": "string", "description": "

seconds aria label

\n" }, { "name": "arrowkeys", "defaultValue": "true", "type": "boolean", "description": "

if true the values of hours and minutes can be changed using the up/down arrow keys on the keyboard

\n" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "

if true hours and minutes fields will be disabled

\n" }, { "name": "hoursPlaceholder", "defaultValue": "HH", "type": "string", "description": "

placeholder for hours field in timepicker

\n" }, { "name": "hourStep", "defaultValue": "1", "type": "number", "description": "

hours change step

\n" }, { "name": "max", "type": "Date", "description": "

maximum time user can select

\n" }, { "name": "meridians", "type": "string[]", "description": "

meridian labels based on locale

\n" }, { "name": "min", "type": "Date", "description": "

minimum time user can select

\n" }, { "name": "minutesPlaceholder", "defaultValue": "MM", "type": "string", "description": "

placeholder for minutes field in timepicker

\n" }, { "name": "minuteStep", "defaultValue": "5", "type": "number", "description": "

minutes change step

\n" }, { "name": "mousewheel", "defaultValue": "true", "type": "boolean", "description": "

if true scroll inside hours and minutes inputs will change time

\n" }, { "name": "readonlyInput", "defaultValue": "false", "type": "boolean", "description": "

if true hours and minutes fields will be readonly

\n" }, { "name": "secondsPlaceholder", "defaultValue": "SS", "type": "string", "description": "

placeholder for seconds field in timepicker

\n" }, { "name": "secondsStep", "defaultValue": "10", "type": "number", "description": "

seconds changes step

\n" }, { "name": "showMeridian", "defaultValue": "true", "type": "boolean", "description": "

if true works in 12H mode and displays AM/PM. If false works in 24H mode and hides AM/PM

\n" }, { "name": "showMinutes", "defaultValue": "true", "type": "boolean", "description": "

show minutes in timepicker

\n" }, { "name": "showSeconds", "defaultValue": "false", "type": "boolean", "description": "

show seconds in timepicker

\n" }, { "name": "showSpinners", "defaultValue": "true", "type": "boolean", "description": "

if true spinner arrows above and below the inputs will be shown

\n" } ] }, "Time": { "fileName": "src/timepicker/timepicker.models.ts", "className": "Time", "description": "", "methods": [], "properties": [] }, "TimepickerControls": { "fileName": "src/timepicker/timepicker.models.ts", "className": "TimepickerControls", "description": "", "methods": [], "properties": [] }, "TimepickerComponentState": { "fileName": "src/timepicker/timepicker.models.ts", "className": "TimepickerComponentState", "description": "", "methods": [], "properties": [] }, "TimeChangeEvent": { "fileName": "src/timepicker/timepicker.models.ts", "className": "TimeChangeEvent", "description": "", "methods": [], "properties": [] }, "TooltipContainerComponent": { "fileName": "src/tooltip/tooltip-container.component.ts", "className": "TooltipContainerComponent", "description": "", "selector": "bs-tooltip-container", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "TooltipConfig": { "fileName": "src/tooltip/tooltip.config.ts", "className": "TooltipConfig", "description": "

Default values provider for tooltip

\n", "methods": [], "properties": [ { "name": "adaptivePosition", "defaultValue": "true", "type": "boolean", "description": "

sets disable adaptive position

\n" }, { "name": "container", "type": "string", "description": "

a selector specifying the element the tooltip should be appended to.

\n" }, { "name": "delay", "defaultValue": "0", "type": "number", "description": "

delay before showing the tooltip

\n" }, { "name": "placement", "defaultValue": "top", "type": "string", "description": "

tooltip placement, supported positions: 'top', 'bottom', 'left', 'right'

\n" }, { "name": "triggers", "defaultValue": "hover focus", "type": "string", "description": "

array of event names which triggers tooltip opening

\n" } ] }, "TooltipDirective": { "fileName": "src/tooltip/tooltip.directive.ts", "className": "TooltipDirective", "description": "", "selector": "[tooltip], [tooltipHtml]", "exportAs": "bs-tooltip", "inputs": [ { "name": "adaptivePosition", "defaultValue": "true", "type": "boolean", "description": "

sets disable adaptive position

\n" }, { "name": "boundariesElement", "type": "\"viewport\" | \"scrollParent\" | \"window\"", "description": "" }, { "name": "container", "type": "string", "description": "

A selector specifying the element the tooltip should be appended to.

\n" }, { "name": "containerClass", "type": "string", "description": "

Css class for tooltip container

\n" }, { "name": "delay", "defaultValue": "0", "type": "number", "description": "

Delay before showing the tooltip

\n" }, { "name": "isDisabled", "defaultValue": "false", "type": "boolean", "description": "

Allows to disable tooltip

\n" }, { "name": "isOpen", "type": "boolean", "description": "

Returns whether or not the tooltip is currently being shown

\n" }, { "name": "placement", "defaultValue": "top", "type": "AvailbleBSPositions", "description": "

Placement of a tooltip. Accepts: "top", "bottom", "left", "right"

\n" }, { "name": "tooltip", "type": "string | TemplateRef", "description": "

Content to be displayed as tooltip.

\n" }, { "name": "tooltipAnimation", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "tooltipAppendToBody", "type": "boolean", "description": "" }, { "name": "tooltipClass", "type": "string", "description": "" }, { "name": "tooltipContext", "type": "undefined", "description": "" }, { "name": "tooltipEnable", "type": "boolean", "description": "" }, { "name": "tooltipFadeDuration", "defaultValue": "150", "type": "number", "description": "" }, { "name": "tooltipHtml", "type": "string | TemplateRef", "description": "" }, { "name": "tooltipIsOpen", "type": "boolean", "description": "" }, { "name": "tooltipPlacement", "type": "AvailbleBSPositions", "description": "" }, { "name": "tooltipPopupDelay", "type": "number", "description": "" }, { "name": "tooltipTrigger", "type": "string | string[]", "description": "" }, { "name": "triggers", "defaultValue": "hover focus", "type": "string", "description": "

Specifies events that should trigger. Supports a space separated list of\nevent names.

\n" } ], "outputs": [ { "name": "onHidden", "description": "

Emits an event when the tooltip is hidden

\n" }, { "name": "onShown", "description": "

Emits an event when the tooltip is shown

\n" }, { "name": "tooltipChange", "description": "

Fired when tooltip content changes

\n" }, { "name": "tooltipStateChanged", "description": "" } ], "properties": [], "methods": [ { "name": "toggle", "description": "

Toggles an element’s tooltip. This is considered a “manual” triggering of\nthe tooltip.

\n", "args": [], "returnType": "void" }, { "name": "show", "description": "

Opens an element’s tooltip. This is considered a “manual” triggering of\nthe tooltip.

\n", "args": [], "returnType": "void" }, { "name": "hide", "description": "

Closes an element’s tooltip. This is considered a “manual” triggering of\nthe tooltip.

\n", "args": [], "returnType": "void" } ] }, "TypeaheadOptionListContext": { "fileName": "src/typeahead/models/index.ts", "className": "TypeaheadOptionListContext", "description": "

A context for the optionsListTemplate\ninput template in case you want to override default one

\n", "methods": [], "properties": [ { "name": "$implicit", "type": "TypeaheadTemplateMethods", "description": "

Typeahead template methods

\n" }, { "name": "itemTemplate", "type": "TemplateRef", "description": "

Item template

\n" }, { "name": "matches", "type": "TypeaheadMatch[]", "description": "

All matches

\n" }, { "name": "query", "type": "string | string[]", "description": "

Search query

\n" } ] }, "TypeaheadOptionItemContext": { "fileName": "src/typeahead/models/index.ts", "className": "TypeaheadOptionItemContext", "description": "

A context for the typeaheadItemTemplate\ninput template in case you want to override default one

\n", "methods": [], "properties": [ { "name": "index", "type": "number", "description": "

Item index

\n" }, { "name": "item", "type": "unknown", "description": "

Item

\n" }, { "name": "match", "type": "TypeaheadMatch", "description": "

Typeahead match

\n" }, { "name": "query", "type": "string | string[]", "description": "

Search query

\n" } ] }, "TypeaheadTemplateMethods": { "fileName": "src/typeahead/models/index.ts", "className": "TypeaheadTemplateMethods", "description": "

Methods for optionsListTemplate context

\n", "methods": [ { "name": "selectMatch", "description": "

Function to select an option by click event

\n", "args": [ { "name": "value", "type": "TypeaheadMatch" }, { "name": "e", "type": "Event" } ], "returnType": "void" }, { "name": "selectActive", "description": "

Function to select an option by mouseenter event

\n", "args": [ { "name": "value", "type": "TypeaheadMatch" } ], "returnType": "void" }, { "name": "isActive", "description": "

Function to check if an option is active

\n", "args": [ { "name": "value", "type": "TypeaheadMatch" } ], "returnType": "boolean" } ], "properties": [] }, "TypeaheadContainerComponent": { "fileName": "src/typeahead/typeahead-container.component.ts", "className": "TypeaheadContainerComponent", "description": "", "selector": "typeahead-container", "inputs": [], "outputs": [ { "name": "activeChange", "description": "" } ], "properties": [], "methods": [] }, "TypeaheadOrder": { "fileName": "src/typeahead/typeahead-order.class.ts", "className": "TypeaheadOrder", "description": "", "methods": [], "properties": [ { "name": "direction", "type": "\"asc\" | \"desc\"", "description": "

ordering direction, could be 'asc' or 'desc'

\n" }, { "name": "field", "type": "string", "description": "

field for sorting

\n" } ] }, "TypeaheadConfig": { "fileName": "src/typeahead/typeahead.config.ts", "className": "TypeaheadConfig", "description": "

Default values provider for typeahead

\n", "methods": [], "properties": [ { "name": "adaptivePosition", "defaultValue": "false", "type": "boolean", "description": "

sets use adaptive position

\n" }, { "name": "cancelRequestOnFocusLost", "defaultValue": "false", "type": "boolean", "description": "

if true, typeahead will cancel async request on blur

\n" }, { "name": "hideResultsOnBlur", "defaultValue": "true", "type": "boolean", "description": "

used to hide results on blur

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" }, { "name": "isFirstItemActive", "defaultValue": "true", "type": "boolean", "description": "

used to active/inactive the first item in typeahead container

\n" }, { "name": "minLength", "defaultValue": "1", "type": "number", "description": "

used to choose set minimal no of characters that needs to\nbe entered before typeahead kicks-in

\n" }, { "name": "selectFirstItem", "defaultValue": "true", "type": "boolean", "description": "

used to choose the first item in typeahead container

\n" }, { "name": "selectItemOnBlur", "defaultValue": "false", "type": "boolean", "description": "

used to choose item on blur event

\n" } ] }, "TypeaheadDirective": { "fileName": "src/typeahead/typeahead.directive.ts", "className": "TypeaheadDirective", "description": "", "selector": "[typeahead]", "exportAs": "bs-typeahead", "inputs": [ { "name": "adaptivePosition", "defaultValue": "false", "type": "boolean", "description": "

sets use adaptive position

\n" }, { "name": "container", "type": "string", "description": "

A selector specifying the element the typeahead should be appended to.

\n" }, { "name": "dropup", "defaultValue": "false", "type": "boolean", "description": "

This attribute indicates that the dropdown should be opened upwards

\n" }, { "name": "isAnimated", "defaultValue": "false", "type": "boolean", "description": "

turn on/off animation

\n" }, { "name": "optionsListTemplate", "type": "TemplateRef", "description": "

used to specify a custom options list template.\nTemplate variables: matches, itemTemplate, query

\n" }, { "name": "typeahead", "type": "TypeaheadOptionArr", "description": "

options source, can be Array of strings, objects or\nan Observable for external matching process

\n" }, { "name": "typeaheadAsync", "type": "boolean", "description": "

should be used only in case of typeahead attribute is Observable of array.\nIf true - loading of options will be async, otherwise - sync.\ntrue make sense if options array is large.

\n" }, { "name": "typeaheadGroupField", "type": "string", "description": "

when options source is an array of objects, the name of field that\ncontains the group value, matches are grouped by this field when set.

\n" }, { "name": "typeaheadHideResultsOnBlur", "type": "boolean", "description": "

used to hide result on blur

\n" }, { "name": "typeaheadIsFirstItemActive", "defaultValue": "true", "type": "boolean", "description": "

makes active first item in a list

\n" }, { "name": "typeaheadItemTemplate", "type": "TemplateRef", "description": "

used to specify a custom item template.\nTemplate variables exposed are called item and index;

\n" }, { "name": "typeaheadLatinize", "defaultValue": "true", "type": "boolean", "description": "

match latin symbols.\nIf true the word súper would match super and vice versa.

\n" }, { "name": "typeaheadMinLength", "defaultValue": "1", "type": "number", "description": "

minimal no of characters that needs to be entered before\ntypeahead kicks-in. When set to 0, typeahead shows on focus with full\nlist of options (limited as normal by typeaheadOptionsLimit)

\n" }, { "name": "typeaheadMultipleSearch", "type": "boolean", "description": "

Can be used to conduct a search of multiple items and have suggestion not for the\nwhole value of the input but for the value that comes after a delimiter provided via\ntypeaheadMultipleSearchDelimiters attribute. This option can only be used together with\ntypeaheadSingleWords option if typeaheadWordDelimiters and typeaheadPhraseDelimiters\nare different from typeaheadMultipleSearchDelimiters to avoid conflict in determining\nwhen to delimit multiple searches and when a single word.

\n" }, { "name": "typeaheadMultipleSearchDelimiters", "defaultValue": ",", "type": "string", "description": "

should be used only in case typeaheadMultipleSearch attribute is true.\nSets the multiple search delimiter to know when to start a new search. Defaults to comma.\nIf space needs to be used, then explicitly set typeaheadWordDelimiters to something else than space\nbecause space is used by default OR set typeaheadSingleWords attribute to false if you don't need\nto use it together with multiple search.

\n" }, { "name": "typeaheadOptionField", "type": "string", "description": "

when options source is an array of objects, the name of field\nthat contains the options value, we use array item as option in case\nof this field is missing. Supports nested properties and methods.

\n" }, { "name": "typeaheadOptionsInScrollableView", "defaultValue": "5", "type": "number", "description": "

specifies number of options to show in scroll view

\n" }, { "name": "typeaheadOptionsLimit", "type": "number", "description": "

maximum length of options items list. The default value is 20

\n" }, { "name": "typeaheadOrderBy", "type": "TypeaheadOrder", "description": "

Used to specify a custom order of matches. When options source is an array of objects\na field for sorting has to be set up. In case of options source is an array of string,\na field for sorting is absent. The ordering direction could be changed to ascending or descending.

\n" }, { "name": "typeaheadPhraseDelimiters", "defaultValue": "'\"", "type": "string", "description": "

should be used only in case typeaheadSingleWords attribute is true.\nSets the word delimiter to match exact phrase.\nDefaults to simple and double quotes.

\n" }, { "name": "typeaheadScrollable", "defaultValue": "false", "type": "boolean", "description": "

specifies if typeahead is scrollable

\n" }, { "name": "typeaheadSelectFirstItem", "defaultValue": "true", "type": "boolean", "description": "

fired when an options list was opened and the user clicked Tab\nIf a value equal true, it will be chosen first or active item in the list\nIf value equal false, it will be chosen an active item in the list or nothing

\n" }, { "name": "typeaheadSingleWords", "defaultValue": "true", "type": "boolean", "description": "

Can be use to search words by inserting a single white space between each characters\nfor example 'C a l i f o r n i a' will match 'California'.

\n" }, { "name": "typeaheadWaitMs", "defaultValue": "0", "type": "number", "description": "

minimal wait time after last character typed before typeahead kicks-in

\n" }, { "name": "typeaheadWordDelimiters", "defaultValue": " ", "type": "string", "description": "

should be used only in case typeaheadSingleWords attribute is true.\nSets the word delimiter to break words. Defaults to space.

\n" } ], "outputs": [ { "name": "typeaheadLoading", "description": "

fired when 'busy' state of this component was changed,\nfired on async mode only, returns boolean

\n" }, { "name": "typeaheadNoResults", "description": "

fired on every key event and returns true\nin case of matches are not detected

\n" }, { "name": "typeaheadOnBlur", "description": "

fired when blur event occurs. returns the active item

\n" }, { "name": "typeaheadOnPreview", "description": "

fired when option was previewed, return object with data of this option.

\n" }, { "name": "typeaheadOnSelect", "description": "

fired when option was selected, return object with data of this option.

\n" } ], "properties": [ { "name": "activeDescendant", "type": "string", "description": "

if false don't focus the input element the typeahead directive is associated with on selection

\n" } ], "methods": [] }, "ListNode": { "fileName": "src/utils/linked-list.class.ts", "className": "ListNode", "description": "", "methods": [], "properties": [] }, "IObjectKeys": { "fileName": "src/utils/theme-provider.ts", "className": "IObjectKeys", "description": "", "methods": [], "properties": [] }, "IBsVersion": { "fileName": "src/utils/theme-provider.ts", "className": "IBsVersion", "description": "", "methods": [], "properties": [] } };