',
+ description: 'Will be emitted when active slides has been changed in multilist mode
\n'
}
]
},
- "SlideWithIndex": {
- "fileName": "src/carousel/models/index.ts",
- "className": "SlideWithIndex",
- "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": []
+ IndexedSlideList: {
+ fileName: 'src/carousel/models/index.ts',
+ className: 'IndexedSlideList',
+ description: '',
+ methods: [],
+ properties: []
},
- "DateParsingConfig": {
- "fileName": "src/chronos/create/parsing.types.ts",
- "className": "DateParsingConfig",
- "description": "",
- "methods": [],
- "properties": [
+ DateParsingConfig: {
+ fileName: 'src/chronos/create/parsing.types.ts',
+ className: 'DateParsingConfig',
+ description: '',
+ methods: [],
+ properties: [
{
- "name": "_a",
- "type": "DateArray",
- "description": "DateArray [year, month, date, .....]
\n"
+ name: '_a',
+ type: 'DateArray',
+ description: 'DateArray [year, month, date, .....]
\n'
},
{
- "name": "_changeInProgress",
- "type": "boolean",
- "description": "used in set offset
\n"
+ name: '_changeInProgress',
+ type: 'boolean',
+ description: 'used in set offset
\n'
},
{
- "name": "_d",
- "type": "Date",
- "description": "date value
\n"
+ name: '_d',
+ type: 'Date',
+ description: 'date value
\n'
},
{
- "name": "_f",
- "type": "string | string[]",
- "description": "date format
\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: '_i',
+ type: 'DateInput',
+ description: 'input to parse: could be string, number[], number, Date, object
\n'
},
{
- "name": "_isPm",
- "type": "boolean",
- "description": "is PM
\n"
+ name: '_isPm',
+ type: 'boolean',
+ description: 'is PM
\n'
},
{
- "name": "_isValid",
- "type": "boolean",
- "description": "is valid
\n"
+ name: '_isValid',
+ type: 'boolean',
+ description: 'is valid
\n'
},
{
- "name": "_l",
- "type": "string",
- "description": "locale key, 'en' by default
\n"
+ name: '_l',
+ type: 'string',
+ description: 'locale key, 'en' by default
\n'
},
{
- "name": "_locale",
- "type": "Locale",
- "description": "date locale obj
\n"
+ name: '_locale',
+ type: 'Locale',
+ description: 'date locale obj
\n'
},
{
- "name": "_meridiem",
- "type": "string",
- "description": "date meridiem
\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: '_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: '_offset',
+ type: 'number',
+ description: 'utc time offset
\n'
},
{
- "name": "_pf",
- "type": "DateParsingFlags",
- "description": "date parsing flags
\n"
+ name: '_pf',
+ type: 'DateParsingFlags',
+ description: 'date parsing flags
\n'
},
{
- "name": "_strict",
- "type": "boolean",
- "description": "use strict parse format
\n"
+ name: '_strict',
+ type: 'boolean',
+ description: 'use strict parse format
\n'
},
{
- "name": "_tzm",
- "type": "number",
- "description": "time zone
\n"
+ name: '_tzm',
+ type: 'number',
+ description: 'time zone
\n'
},
{
- "name": "_w",
- "type": "WeekParsing",
- "description": "week
\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": []
+ 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: []
},
- "DateFormatterOptions": {
- "fileName": "src/chronos/types.ts",
- "className": "DateFormatterOptions",
- "description": "",
- "methods": [],
- "properties": []
+ WeekParsing: {
+ fileName: 'src/chronos/types.ts',
+ className: 'WeekParsing',
+ description: '',
+ methods: [],
+ properties: []
},
- "DateObject": {
- "fileName": "src/chronos/types.ts",
- "className": "DateObject",
- "description": "",
- "methods": [],
- "properties": []
+ ListenOptions: {
+ fileName: 'src/utils/triggers.ts',
+ className: 'ListenOptions',
+ description: '',
+ methods: [],
+ properties: []
},
- "WeekParsing": {
- "fileName": "src/chronos/types.ts",
- "className": "WeekParsing",
- "description": "",
- "methods": [],
- "properties": []
- },
- "ListenOptions": {
- "fileName": "src/utils/triggers.ts",
- "className": "ListenOptions",
- "description": "",
- "methods": [],
- "properties": []
- },
- "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": [
+ 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: 'adaptivePosition',
+ defaultValue: 'false',
+ type: 'boolean',
+ description: 'sets use adaptive position
\n'
},
{
- "name": "allowedPositions",
- "type": "string[]",
- "description": "Set allowed positions of container.
\n"
+ name: 'allowedPositions',
+ type: 'string[]',
+ description: 'Set allowed positions of container.
\n'
},
{
- "name": "clearButtonLabel",
- "defaultValue": "Clear",
- "type": "string",
- "description": "Label for 'clear' button
\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: '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: '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: '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: '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: 'dateCustomClasses',
+ type: 'DatepickerDateCustomClasses[]',
+ description: 'Default date custom classes for all date/range pickers
\n'
},
{
- "name": "datesDisabled",
- "type": "Date[]",
- "description": "Disable specific dates
\n"
+ name: 'datesDisabled',
+ type: 'Date[]',
+ description: 'Disable specific dates
\n'
},
{
- "name": "datesEnabled",
- "type": "Date[]",
- "description": "Enable 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: '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: '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- maxDate is equal to today's date
\n- minDate's month is equal to maxDate's month
\n
\n"
+ name: 'displayOneMonthRange',
+ type: 'boolean',
+ description:
+ 'Show one months for special cases (only for dateRangePicker)
\n\n- maxDate is equal to today's date
\n- minDate's month is equal to maxDate's month
\n
\n'
},
{
- "name": "initCurrentTime",
- "type": "boolean",
- "description": "Set current hours, minutes, seconds and milliseconds for bsValue
\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: 'isAnimated',
+ defaultValue: 'false',
+ type: 'boolean',
+ description: 'turn on/off animation
\n'
},
{
- "name": "keepDatepickerOpened",
- "defaultValue": "false",
- "type": "boolean",
- "description": "Set rule for datepicker closing. If value is true datepicker closes only if date is changed, if user changes only time datepicker doesn't close. It is available only if property withTimepicker is set true
\n"
+ name: 'keepDatepickerOpened',
+ defaultValue: 'false',
+ type: 'boolean',
+ description:
+ 'Set rule for datepicker closing. If value is true datepicker closes only if date is changed, if user changes only time datepicker doesn't close. It is available only if property withTimepicker is set true
\n'
},
{
- "name": "keepDatesOutOfRules",
- "defaultValue": "false",
- "type": "boolean",
- "description": "Allows keep invalid dates in range. Can be used with minDate, maxDate
\n"
+ name: 'keepDatesOutOfRules',
+ defaultValue: 'false',
+ type: 'boolean',
+ description: 'Allows keep invalid dates in range. Can be used with minDate, maxDate
\n'
},
{
- "name": "maxDate",
- "type": "Date",
- "description": "Default max date for all date/range pickers
\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: '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: '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: '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: '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: 'rangeInputFormat',
+ defaultValue: 'L',
+ type: 'string',
+ description: 'Date format for date range input field
\n'
},
{
- "name": "ranges",
- "type": "BsCustomDates[]",
- "description": "Predefined ranges
\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: '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: '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: '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: '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: '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: '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: '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: '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: '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: 'todayButtonLabel',
+ defaultValue: 'Today',
+ type: 'string',
+ description: 'Label for 'today' button
\n'
},
{
- "name": "todayPosition",
- "defaultValue": "center",
- "type": "string",
- "description": "Positioning of '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: '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"
+ name: 'withTimepicker',
+ defaultValue: 'false',
+ type: 'boolean',
+ description: 'Shows timepicker under datepicker
\n'
}
]
},
- "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": []
- },
- "BsDatepickerViewState": {
- "fileName": "src/datepicker/reducer/bs-datepicker.state.ts",
- "className": "BsDatepickerViewState",
- "description": "",
- "methods": [],
- "properties": []
- },
- "BsCustomDates": {
- "fileName": "src/datepicker/themes/bs/bs-custom-dates-view.component.ts",
- "className": "BsCustomDates",
- "description": "",
- "methods": [],
- "properties": []
- },
- "MatrixOptions": {
- "fileName": "src/datepicker/utils/matrix-utils.ts",
- "className": "MatrixOptions",
- "description": "",
- "methods": [],
- "properties": []
- },
- "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"
+ 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: []
+ },
+ BsDatepickerViewState: {
+ fileName: 'src/datepicker/reducer/bs-datepicker.state.ts',
+ className: 'BsDatepickerViewState',
+ description: '',
+ methods: [],
+ properties: []
+ },
+ BsCustomDates: {
+ fileName: 'src/datepicker/themes/bs/bs-custom-dates-view.component.ts',
+ className: 'BsCustomDates',
+ description: '',
+ methods: [],
+ properties: []
+ },
+ MatrixOptions: {
+ fileName: 'src/datepicker/utils/matrix-utils.ts',
+ className: 'MatrixOptions',
+ description: '',
+ methods: [],
+ properties: []
+ },
+ 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'
}
]
},
- "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"
+ 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": [
+ 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: 'create',
+ description: 'Creates a focus-trapped region around the given element.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
},
{
- "name": "config",
- "type": "ConfigurableFocusTrapConfig"
+ name: 'config',
+ type: 'ConfigurableFocusTrapConfig'
}
],
- "returnType": "ConfigurableFocusTrap"
+ returnType: 'ConfigurableFocusTrap'
},
{
- "name": "create",
- "description": "Creates a focus-trapped region around the given element.
\n",
- "args": [
+ name: 'create',
+ description: 'Creates a focus-trapped region around the given element.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
},
{
- "name": "deferCaptureElements",
- "type": "boolean"
+ name: 'deferCaptureElements',
+ type: 'boolean'
}
],
- "returnType": "ConfigurableFocusTrap"
+ returnType: 'ConfigurableFocusTrap'
},
{
- "name": "create",
- "description": "Creates a focus-trapped region around the given element.
\n",
- "args": [
+ name: 'create',
+ description: 'Creates a focus-trapped region around the given element.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
},
{
- "name": "config",
- "type": "boolean | ConfigurableFocusTrapConfig"
+ name: 'config',
+ type: 'boolean | ConfigurableFocusTrapConfig'
}
],
- "returnType": "ConfigurableFocusTrap"
+ 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.
\nThis 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: []
+ },
+ ConfigurableFocusTrap: {
+ fileName: 'src/focus-trap/configurable-focus-trap.ts',
+ className: 'ConfigurableFocusTrap',
+ description:
+ 'Class that allows for trapping focus within a DOM element.
\nThis 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": [
+ properties: [
{
- "name": "enabled",
- "type": "boolean",
- "description": "Whether the FocusTrap is enabled.
\n"
+ 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": [
+ 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: 'preventFocus',
+ description: 'Adds a document event listener that keeps focus inside the FocusTrap.
\n',
+ args: [
{
- "name": "focusTrap",
- "type": "ConfigurableFocusTrap"
+ name: 'focusTrap',
+ type: 'ConfigurableFocusTrap'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "allowFocus",
- "description": "Removes the event listener added in preventFocus.
\n",
- "args": [
+ name: 'allowFocus',
+ description: 'Removes the event listener added in preventFocus.
\n',
+ args: [
{
- "name": "focusTrap",
- "type": "ConfigurableFocusTrap"
+ name: 'focusTrap',
+ type: 'ConfigurableFocusTrap'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "_trapFocus",
- "description": "Refocuses the first element in the FocusTrap if the focus event target was outside\nthe FocusTrap.
\nThis is an event listener callback. The event listener is added in runOutsideAngular,\nso all this code runs outside Angular as well.
\n",
- "args": [
+ name: '_trapFocus',
+ description:
+ 'Refocuses the first element in the FocusTrap if the focus event target was outside\nthe FocusTrap.
\nThis 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: 'focusTrap',
+ type: 'ConfigurableFocusTrap'
},
{
- "name": "event",
- "type": "FocusEvent"
+ name: 'event',
+ type: 'FocusEvent'
}
],
- "returnType": "void"
+ returnType: 'void'
}
],
- "properties": [
+ properties: [
{
- "name": "_listener",
- "type": "(e: FocusEvent) => void",
- "description": "Focus event handler.
\n"
+ 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": [
+ 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: 'preventFocus',
+ description: 'Makes all elements outside focusTrap unfocusable.
\n',
+ args: [
{
- "name": "focusTrap",
- "type": "FocusTrap"
+ name: 'focusTrap',
+ type: 'FocusTrap'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "allowFocus",
- "description": "Reverts elements made unfocusable by preventFocus to their previous state.
\n",
- "args": [
+ name: 'allowFocus',
+ description: 'Reverts elements made unfocusable by preventFocus to their previous state.
\n',
+ args: [
{
- "name": "focusTrap",
- "type": "FocusTrap"
+ name: 'focusTrap',
+ type: 'FocusTrap'
}
],
- "returnType": "void"
+ 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": [
+ 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"
+ name: 'focusTrap',
+ type: 'ManagedFocusTrap'
}
],
- "returnType": "void"
+ 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: '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"
+ name: 'focusTrap',
+ type: 'ManagedFocusTrap'
}
],
- "returnType": "void"
+ returnType: 'void'
}
],
- "properties": []
+ properties: []
},
- "FocusTrap": {
- "fileName": "src/focus-trap/focus-trap.ts",
- "className": "FocusTrap",
- "description": "Class that allows for trapping focus within a DOM element.
\nThis 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": [
+ FocusTrap: {
+ fileName: 'src/focus-trap/focus-trap.ts',
+ className: 'FocusTrap',
+ description:
+ 'Class that allows for trapping focus within a DOM element.
\nThis 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: '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: '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: '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: '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: '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: '_getRegionBoundary',
+ description: 'Get the specified boundary element of the trapped region.
\n',
+ args: [
{
- "name": "bound",
- "type": "\"start\" | \"end\""
+ name: 'bound',
+ type: '"start" | "end"'
}
],
- "returnType": "HTMLElement"
+ returnType: 'HTMLElement'
},
{
- "name": "focusInitialElement",
- "description": "Focuses the element that should be focused when the focus trap is initialized.
\n",
- "args": [],
- "returnType": "boolean"
+ 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: '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: '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: '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: '_getFirstTabbableElement',
+ description: 'Get the first tabbable element from a DOM subtree (inclusive).
\n',
+ args: [
{
- "name": "root",
- "type": "HTMLElement"
+ name: 'root',
+ type: 'HTMLElement'
}
],
- "returnType": "HTMLElement"
+ returnType: 'HTMLElement'
},
{
- "name": "_getLastTabbableElement",
- "description": "Get the last tabbable element from a DOM subtree (inclusive).
\n",
- "args": [
+ name: '_getLastTabbableElement',
+ description: 'Get the last tabbable element from a DOM subtree (inclusive).
\n',
+ args: [
{
- "name": "root",
- "type": "HTMLElement"
+ name: 'root',
+ type: 'HTMLElement'
}
],
- "returnType": "HTMLElement"
+ returnType: 'HTMLElement'
},
{
- "name": "_createAnchor",
- "description": "Creates an anchor element.
\n",
- "args": [],
- "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: '_toggleAnchorTabIndex',
+ description:
+ 'Toggles the tabindex
of an anchor, based on the enabled state of the focus trap.
\n',
+ args: [
{
- "name": "isEnabled",
- "type": "boolean"
+ name: 'isEnabled',
+ type: 'boolean'
},
{
- "name": "anchor",
- "type": "HTMLElement"
+ name: 'anchor',
+ type: 'HTMLElement'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "toggleAnchors",
- "description": "Toggles thetabindex
of both anchors to either trap Tab focus or allow it to escape.
\n",
- "args": [
+ name: 'toggleAnchors',
+ description:
+ 'Toggles thetabindex
of both anchors to either trap Tab focus or allow it to escape.
\n',
+ args: [
{
- "name": "enabled",
- "type": "boolean"
+ name: 'enabled',
+ type: 'boolean'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "_executeOnStable",
- "description": "Executes a function when the zone is stable.
\n",
- "args": [
+ name: '_executeOnStable',
+ description: 'Executes a function when the zone is stable.
\n',
+ args: [
{
- "name": "fn",
- "type": "() => any"
+ name: 'fn',
+ type: '() => any'
}
],
- "returnType": "void"
+ returnType: 'void'
}
],
- "properties": [
+ properties: [
{
- "name": "enabled",
- "type": "boolean",
- "description": "Whether the focus trap is active.
\n"
+ 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": [
+ 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: 'create',
+ description: 'Creates a focus-trapped region around the given element.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
},
{
- "name": "deferCaptureElements",
- "type": "boolean"
+ name: 'deferCaptureElements',
+ type: 'boolean'
}
],
- "returnType": "FocusTrap"
+ returnType: 'FocusTrap'
}
],
- "properties": []
+ properties: []
},
- "FocusTrapDirective": {
- "fileName": "src/focus-trap/focus-trap.ts",
- "className": "FocusTrapDirective",
- "description": "Directive for trapping focus within a region.
\n",
- "methods": [],
- "properties": [
+ FocusTrapDirective: {
+ fileName: 'src/focus-trap/focus-trap.ts',
+ className: 'FocusTrapDirective',
+ description: 'Directive for trapping focus within a region.
\n',
+ methods: [],
+ properties: [
{
- "name": "_previouslyFocusedElement",
- "type": "HTMLElement",
- "description": "Previously focused element to restore focus to upon destroy when using autoCapture.
\n"
+ name: '_previouslyFocusedElement',
+ type: 'HTMLElement',
+ description: 'Previously focused element to restore focus to upon destroy when using autoCapture.
\n'
},
{
- "name": "autoCapture",
- "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"
+ name: 'autoCapture',
+ 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'
},
{
- "name": "enabled",
- "type": "boolean",
- "description": "Whether the focus trap is active.
\n"
+ name: 'enabled',
+ type: 'boolean',
+ description: 'Whether the focus trap is active.
\n'
},
{
- "name": "focusTrap",
- "type": "FocusTrap",
- "description": "Underlying FocusTrap instance.
\n"
+ name: 'focusTrap',
+ type: 'FocusTrap',
+ description: 'Underlying FocusTrap instance.
\n'
}
]
},
- "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"
+ 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": [
+ 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: 'isDisabled',
+ description: 'Gets whether an element is disabled.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
}
],
- "returnType": "boolean"
+ returnType: 'boolean'
},
{
- "name": "isVisible",
- "description": "Gets whether an element is visible for the purposes of interactivity.
\nThis 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: 'isVisible',
+ description:
+ 'Gets whether an element is visible for the purposes of interactivity.
\nThis 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"
+ name: 'element',
+ type: 'HTMLElement'
}
],
- "returnType": "boolean"
+ 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: '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"
+ name: 'element',
+ type: 'HTMLElement'
}
],
- "returnType": "boolean"
+ returnType: 'boolean'
},
{
- "name": "isFocusable",
- "description": "Gets whether an element can be focused by the user.
\n",
- "args": [
+ name: 'isFocusable',
+ description: 'Gets whether an element can be focused by the user.
\n',
+ args: [
{
- "name": "element",
- "type": "HTMLElement"
+ name: 'element',
+ type: 'HTMLElement'
},
{
- "name": "config",
- "type": "IsFocusableConfig"
+ name: 'config',
+ type: 'IsFocusableConfig'
}
],
- "returnType": "boolean"
+ returnType: 'boolean'
}
],
- "properties": []
+ 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": [
+ 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: '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: '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: '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: '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: '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: '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: '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: '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"
+ 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": []
- },
- "ModalBackdropComponent": {
- "fileName": "src/modal/modal-backdrop.component.ts",
- "className": "ModalBackdropComponent",
- "description": "This component will be added as background layout for modals if enabled
\n",
- "methods": [],
- "properties": []
- },
- "ModalDirective": {
- "fileName": "src/modal/modal.directive.ts",
- "className": "ModalDirective",
- "description": "Mark any code with directive to show it's content in modal
\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": [
+ Action: {
+ fileName: 'src/mini-ngrx/public_api.ts',
+ className: 'Action',
+ description: '',
+ methods: [],
+ 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',
+ methods: [],
+ properties: []
+ },
+ ModalDirective: {
+ fileName: 'src/modal/modal.directive.ts',
+ className: 'ModalDirective',
+ description: 'Mark any code with directive to show it's content in modal
\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"
+ name: 'event',
+ type: 'Event'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "_hide",
- "description": "Manually close modal
\n",
- "args": [],
- "returnType": "void"
+ name: '_hide',
+ description: 'Manually close modal
\n',
+ args: [],
+ returnType: 'void'
},
{
- "name": "showElement",
- "description": "Show dialog
\n",
- "args": [],
- "returnType": "void"
+ name: 'showElement',
+ description: 'Show dialog
\n',
+ args: [],
+ returnType: 'void'
},
{
- "name": "focusOtherModal",
- "description": "Events tricks
\n",
- "args": [],
- "returnType": "void"
+ name: 'focusOtherModal',
+ description: 'Events tricks
\n',
+ args: [],
+ returnType: 'void'
}
],
- "properties": [
+ properties: [
{
- "name": "closeInterceptor",
- "type": "CloseInterceptorFn",
- "description": "allows to provide a callback to intercept the closure of the modal
\n"
+ 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"
+ 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"
+ 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'
},
{
- "name": "onHidden",
- "type": "EventEmitter",
- "description": "This event is fired when the modal has finished being\nhidden from the user (will wait for CSS transitions to complete).
\n"
+ name: 'onHidden',
+ type: 'EventEmitter',
+ 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",
- "type": "EventEmitter",
- "description": "This event is fired immediately when\nthe hide instance method has been called.
\n"
+ name: 'onHide',
+ type: 'EventEmitter',
+ description: 'This event is fired immediately when\nthe hide instance method has been called.
\n'
},
{
- "name": "onShow",
- "type": "EventEmitter",
- "description": "This event fires immediately when the show
instance method is called.
\n"
+ name: 'onShow',
+ type: 'EventEmitter',
+ description: 'This event fires immediately when the show
instance method is called.
\n'
},
{
- "name": "onShown",
- "type": "EventEmitter",
- "description": "This event is fired when the modal has been made visible to the user\n(will wait for CSS transitions to complete)
\n"
+ name: 'onShown',
+ type: 'EventEmitter',
+ description:
+ 'This event is fired when the modal has been made visible to the user\n(will wait for CSS transitions to complete)
\n'
}
]
},
- "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"
+ 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\ncustomPageTemplate
\ncustomNextTemplate
\ncustomPreviousTemplate
\ncustomFirstTemplate
\ncustomLastTemplate
\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"
+ 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\ncustomPageTemplate
\ncustomNextTemplate
\ncustomPreviousTemplate
\ncustomFirstTemplate
\ncustomLastTemplate
\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": [
+ 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"
+ name: '$implicit',
+ type: 'PagesModel',
+ description: 'Contain the page information
\n'
}
]
},
- "PageChangedEvent": {
- "fileName": "src/pagination/pagination.component.ts",
- "className": "PageChangedEvent",
- "description": "",
- "methods": [],
- "properties": []
+ PageChangedEvent: {
+ fileName: 'src/pagination/pagination.component.ts',
+ className: 'PageChangedEvent',
+ description: '',
+ methods: [],
+ properties: []
},
- "PaginationConfig": {
- "fileName": "src/pagination/pagination.config.ts",
- "className": "PaginationConfig",
- "description": "Provides default values for Pagination and pager components
\n",
- "methods": [],
- "properties": []
+ PaginationConfig: {
+ fileName: 'src/pagination/pagination.config.ts',
+ className: 'PaginationConfig',
+ description: 'Provides default values for Pagination and pager components
\n',
+ methods: [],
+ properties: []
},
- "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": [
+ 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: '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: '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: '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: '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"
+ 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",
- "methods": [
+ PopoverDirective: {
+ fileName: 'src/popover/popover.directive.ts',
+ className: 'PopoverDirective',
+ description: 'A lightweight, extensible directive for fancy popover creation.
\n',
+ methods: [
{
- "name": "setAriaDescribedBy",
- "description": "Set attribute aria-describedBy for element directive and\nset id for the popover
\n",
- "args": [],
- "returnType": "void"
+ 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: '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: '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"
+ name: 'toggle',
+ description: 'Toggles an element’s popover. This is considered a “manual” triggering of\nthe popover.
\n',
+ args: [],
+ returnType: 'void'
}
],
- "properties": [
+ properties: [
{
- "name": "adaptivePosition",
- "defaultValue": "true",
- "type": "boolean",
- "description": "sets disable adaptive position
\n"
+ 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: '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: 'containerClass',
+ type: 'string',
+ description: 'Css class for popover container
\n'
},
{
- "name": "delay",
- "defaultValue": "0",
- "type": "number",
- "description": "Delay before showing the tooltip
\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: 'isOpen',
+ type: 'boolean',
+ description: 'Returns whether or not the popover is currently being shown
\n'
},
{
- "name": "onHidden",
- "type": "EventEmitter",
- "description": "Emits an event when the popover is hidden
\n"
+ name: 'onHidden',
+ type: 'EventEmitter',
+ description: 'Emits an event when the popover is hidden
\n'
},
{
- "name": "onShown",
- "type": "EventEmitter",
- "description": "Emits an event when the popover is shown
\n"
+ name: 'onShown',
+ type: 'EventEmitter',
+ description: 'Emits an event when the popover is shown
\n'
},
{
- "name": "outsideClick",
- "defaultValue": "false",
- "type": "boolean",
- "description": "Close popover on outside click
\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: 'placement',
+ defaultValue: 'top',
+ type: 'AvailableBSPositions',
+ 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: '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: 'popoverContext',
+ type: 'any',
+ description: 'Context to be used if popover is a template.
\n'
},
{
- "name": "popoverId",
- "type": "number",
- "description": "unique id popover - use for aria-describedby
\n"
+ name: 'popoverId',
+ type: 'number',
+ description: 'unique id popover - use for aria-describedby
\n'
},
{
- "name": "popoverTitle",
- "type": "string",
- "description": "Title of a popover.
\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: 'triggers',
+ defaultValue: 'click',
+ type: 'string',
+ description: 'Specifies events that should trigger. Supports a space separated list of\nevent names.
\n'
}
]
},
- "Offsets": {
- "fileName": "src/positioning/models/index.ts",
- "className": "Offsets",
- "description": "",
- "methods": [],
- "properties": []
+ Offsets: {
+ fileName: 'src/positioning/models/index.ts',
+ className: 'Offsets',
+ description: '',
+ methods: [],
+ properties: []
},
- "Data": {
- "fileName": "src/positioning/models/index.ts",
- "className": "Data",
- "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": []
+ Options: {
+ fileName: 'src/positioning/models/index.ts',
+ className: 'Options',
+ description: '',
+ methods: [],
+ properties: []
},
- "PositioningOptions": {
- "fileName": "src/positioning/positioning.service.ts",
- "className": "PositioningOptions",
- "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: '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: '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: '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: '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: '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: '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"
+ name: 'targetOffset',
+ type: 'string',
+ description: 'A string similar to offset
, but referring to the offset of the target
\n'
}
]
},
- "BarValue": {
- "fileName": "src/progressbar/progressbar-type.interface.ts",
- "className": "BarValue",
- "description": "",
- "methods": [],
- "properties": []
- },
- "RatingResults": {
- "fileName": "src/rating/models/index.ts",
- "className": "RatingResults",
- "description": "",
- "methods": [],
- "properties": []
- },
- "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"
+ BarValue: {
+ fileName: 'src/progressbar/progressbar-type.interface.ts',
+ className: 'BarValue',
+ description: '',
+ methods: [],
+ properties: []
+ },
+ RatingResults: {
+ fileName: 'src/rating/models/index.ts',
+ className: 'RatingResults',
+ description: '',
+ methods: [],
+ properties: []
+ },
+ 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": []
+ 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: []
},
- "DraggableItem": {
- "fileName": "src/sortable/draggable-item.ts",
- "className": "DraggableItem",
- "description": "",
- "methods": [],
- "properties": []
+ DraggableItem: {
+ fileName: 'src/sortable/draggable-item.ts',
+ className: 'DraggableItem',
+ description: '',
+ methods: [],
+ properties: []
},
- "SortableItem": {
- "fileName": "src/sortable/sortable.component.ts",
- "className": "SortableItem",
- "description": "",
- "methods": [],
- "properties": []
+ SortableItem: {
+ fileName: 'src/sortable/sortable.component.ts',
+ className: 'SortableItem',
+ description: '',
+ methods: [],
+ properties: []
},
- "TabHeadingDirective": {
- "fileName": "src/tabs/tab-heading.directive.ts",
- "className": "TabHeadingDirective",
- "description": "Should be used to mark element as a template for tab heading
\n",
- "methods": [],
- "properties": []
+ TabHeadingDirective: {
+ fileName: 'src/tabs/tab-heading.directive.ts',
+ className: 'TabHeadingDirective',
+ description: 'Should be used to mark element as a template for tab heading
\n',
+ methods: [],
+ properties: []
},
- "ControlValueAccessorModel": {
- "fileName": "src/timepicker/models/index.ts",
- "className": "ControlValueAccessorModel",
- "description": "",
- "methods": [],
- "properties": []
+ ControlValueAccessorModel: {
+ fileName: 'src/timepicker/models/index.ts',
+ className: 'ControlValueAccessorModel',
+ description: '',
+ methods: [],
+ properties: []
},
- "TimepickerState": {
- "fileName": "src/timepicker/reducer/timepicker.reducer.ts",
- "className": "TimepickerState",
- "description": "",
- "methods": [],
- "properties": []
+ TimepickerState: {
+ fileName: 'src/timepicker/reducer/timepicker.reducer.ts',
+ className: 'TimepickerState',
+ description: '',
+ methods: [],
+ properties: []
},
- "TimepickerConfig": {
- "fileName": "src/timepicker/timepicker.config.ts",
- "className": "TimepickerConfig",
- "description": "Provides default configuration values for timepicker
\n",
- "methods": [],
- "properties": [
+ 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: '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: 'ariaLabelHours',
+ defaultValue: 'hours',
+ type: 'string',
+ description: 'hours aria label
\n'
},
{
- "name": "ariaLabelMinutes",
- "defaultValue": "minutes",
- "type": "string",
- "description": "minutes 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: '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: '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: '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: '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: 'hourStep',
+ defaultValue: '1',
+ type: 'number',
+ description: 'hours change step
\n'
},
{
- "name": "max",
- "type": "Date",
- "description": "maximum time user can select
\n"
+ name: 'max',
+ type: 'Date',
+ description: 'maximum time user can select
\n'
},
{
- "name": "meridians",
- "type": "string[]",
- "description": "meridian labels based on locale
\n"
+ name: 'meridians',
+ type: 'string[]',
+ description: 'meridian labels based on locale
\n'
},
{
- "name": "min",
- "type": "Date",
- "description": "minimum time user can select
\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: '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: '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: '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: '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: '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: '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: '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: 'showMinutes',
+ defaultValue: 'true',
+ type: 'boolean',
+ description: 'show minutes in timepicker
\n'
},
{
- "name": "showSeconds",
- "defaultValue": "false",
- "type": "boolean",
- "description": "show seconds 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"
+ 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": []
- },
- "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"
+ 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: []
+ },
+ 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'
}
]
},
- "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": [
+ 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: '$implicit',
+ type: 'TypeaheadTemplateMethods',
+ description: 'Typeahead template methods
\n'
},
{
- "name": "itemTemplate",
- "type": "TemplateRef",
- "description": "Item template
\n"
+ name: 'itemTemplate',
+ type: 'TemplateRef',
+ description: 'Item template
\n'
},
{
- "name": "matches",
- "type": "TypeaheadMatch[]",
- "description": "All matches
\n"
+ name: 'matches',
+ type: 'TypeaheadMatch[]',
+ description: 'All matches
\n'
},
{
- "name": "query",
- "type": "string | string[]",
- "description": "Search query
\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": [
+ 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: 'index',
+ type: 'number',
+ description: 'Item index
\n'
},
{
- "name": "item",
- "type": "unknown",
- "description": "Item
\n"
+ name: 'item',
+ type: 'unknown',
+ description: 'Item
\n'
},
{
- "name": "match",
- "type": "TypeaheadMatch",
- "description": "Typeahead match
\n"
+ name: 'match',
+ type: 'TypeaheadMatch',
+ description: 'Typeahead match
\n'
},
{
- "name": "query",
- "type": "string | string[]",
- "description": "Search query
\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": [
+ 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: 'selectMatch',
+ description: 'Function to select an option by click event
\n',
+ args: [
{
- "name": "value",
- "type": "TypeaheadMatch"
+ name: 'value',
+ type: 'TypeaheadMatch'
},
{
- "name": "e",
- "type": "Event"
+ name: 'e',
+ type: 'Event'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "selectActive",
- "description": "Function to select an option by mouseenter event
\n",
- "args": [
+ name: 'selectActive',
+ description: 'Function to select an option by mouseenter event
\n',
+ args: [
{
- "name": "value",
- "type": "TypeaheadMatch"
+ name: 'value',
+ type: 'TypeaheadMatch'
}
],
- "returnType": "void"
+ returnType: 'void'
},
{
- "name": "isActive",
- "description": "Function to check if an option is active
\n",
- "args": [
+ name: 'isActive',
+ description: 'Function to check if an option is active
\n',
+ args: [
{
- "name": "value",
- "type": "TypeaheadMatch"
+ name: 'value',
+ type: 'TypeaheadMatch'
}
],
- "returnType": "boolean"
+ returnType: 'boolean'
}
],
- "properties": []
+ properties: []
},
- "TypeaheadOrder": {
- "fileName": "src/typeahead/typeahead-order.class.ts",
- "className": "TypeaheadOrder",
- "description": "",
- "methods": [],
- "properties": [
+ 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: 'direction',
+ type: '"asc" | "desc"',
+ description: 'ordering direction, could be 'asc' or 'desc'
\n'
},
{
- "name": "field",
- "type": "string",
- "description": "field for sorting
\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": [
+ 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: '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: '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: '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: '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: '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: '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: '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"
+ name: 'selectItemOnBlur',
+ defaultValue: 'false',
+ type: 'boolean',
+ description: 'used to choose item on blur event
\n'
}
]
},
- "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": []
+ 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: []
}
};
diff --git a/apps/ngx-bootstrap-docs/src/polyfills.ts b/apps/ngx-bootstrap-docs/src/polyfills.ts
index 41de7eedc2..370a910111 100644
--- a/apps/ngx-bootstrap-docs/src/polyfills.ts
+++ b/apps/ngx-bootstrap-docs/src/polyfills.ts
@@ -26,6 +26,6 @@ import 'zone.js';
// import 'intl/locale-data/jsonp/en';
/***************************************************************************************************
-* SCULLY IMPORTS
-*/
-import 'zone.js/dist/task-tracking';
+ * SCULLY IMPORTS
+ */
+import 'zone.js/plugins/task-tracking';
diff --git a/libs/common-docs/project.json b/libs/common-docs/project.json
index 88a18f360f..89830cd128 100644
--- a/libs/common-docs/project.json
+++ b/libs/common-docs/project.json
@@ -24,12 +24,9 @@
]
},
"lint": {
- "executor": "@nx/linter:eslint",
+ "executor": "@nx/eslint:lint",
"options": {
- "lintFilePatterns": [
- "libs/common-docs/src/**/*.ts",
- "libs/common-docs/src/**/*.html"
- ]
+ "lintFilePatterns": ["libs/common-docs/src/**/*.ts", "libs/common-docs/src/**/*.html"]
}
}
}
diff --git a/libs/common-docs/src/lib/api-docs/analytics/analytics.ts b/libs/common-docs/src/lib/api-docs/analytics/analytics.ts
index 409ae6d62d..763f832dec 100644
--- a/libs/common-docs/src/lib/api-docs/analytics/analytics.ts
+++ b/libs/common-docs/src/lib/api-docs/analytics/analytics.ts
@@ -7,7 +7,7 @@ import { NavigationEnd, Router } from '@angular/router';
import { Location } from '@angular/common';
import { filter } from 'rxjs/operators';
-
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
declare const ga: any;
/**
@@ -15,7 +15,7 @@ declare const ga: any;
* unless the app is deployed on ng-bootstrap.github.io. This avoids sending
* events and page views during development.
*/
-@Injectable({providedIn: 'root'})
+@Injectable({ providedIn: 'root' })
export class Analytics {
private enabled: boolean;
private location: Location;
@@ -35,11 +35,7 @@ export class Analytics {
if (!this.enabled) {
return;
}
- this.router.events
- .pipe(
- filter((event: any) => event instanceof NavigationEnd)
- )
- .subscribe(() => {
+ this.router.events.pipe(filter((event) => event instanceof NavigationEnd)).subscribe(() => {
if (typeof ga !== 'undefined') {
ga('send', { hitType: 'pageview', page: this.location.path() });
}
diff --git a/libs/common-docs/src/lib/api-docs/api-docs.model.ts b/libs/common-docs/src/lib/api-docs/api-docs.model.ts
index 8376b29016..baa7554dd4 100644
--- a/libs/common-docs/src/lib/api-docs/api-docs.model.ts
+++ b/libs/common-docs/src/lib/api-docs/api-docs.model.ts
@@ -49,12 +49,11 @@ export type OutputDesc = PropertyDesc;
* :D
*/
export class NgApiDoc {
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
}
export function signature(method: MethodDesc): string {
- const args = method.args
- .map((arg: ArgumentDesc) => `${arg.name}: ${arg.type}`)
- .join(', ');
+ const args = method.args.map((arg: ArgumentDesc) => `${arg.name}: ${arg.type}`).join(', ');
return `${method.name}(${args})`;
}
diff --git a/libs/common-docs/src/lib/api-docs/index.ts b/libs/common-docs/src/lib/api-docs/index.ts
index 542493605c..6a659b7ecb 100644
--- a/libs/common-docs/src/lib/api-docs/index.ts
+++ b/libs/common-docs/src/lib/api-docs/index.ts
@@ -5,7 +5,6 @@
// todo: add configuration of base url for source code
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
-import { Analytics } from './analytics/analytics';
import { NgApiDocComponent } from './api-doc/api-doc.component';
import { NgApiDocClassComponent } from './api-doc-class/api-doc-class.component';
import { NgApiDocConfigComponent } from './api-doc-config/api-doc-config.component';
@@ -20,17 +19,7 @@ export { SampleBoxComponent } from './sample-box/sample-box.component';
@NgModule({
imports: [CommonModule, TabsModule],
- declarations: [
- NgApiDocComponent,
- NgApiDocClassComponent,
- NgApiDocConfigComponent,
- SampleBoxComponent
- ],
- exports: [
- NgApiDocComponent,
- NgApiDocClassComponent,
- NgApiDocConfigComponent,
- SampleBoxComponent
- ]
+ declarations: [NgApiDocComponent, NgApiDocClassComponent, NgApiDocConfigComponent, SampleBoxComponent],
+ exports: [NgApiDocComponent, NgApiDocClassComponent, NgApiDocConfigComponent, SampleBoxComponent]
})
export class NgApiDocModule {}
diff --git a/libs/common-docs/src/lib/common/breadCrumbs/breadCrumbs.component.ts b/libs/common-docs/src/lib/common/breadCrumbs/breadCrumbs.component.ts
index 46836ce931..9dab428bce 100644
--- a/libs/common-docs/src/lib/common/breadCrumbs/breadCrumbs.component.ts
+++ b/libs/common-docs/src/lib/common/breadCrumbs/breadCrumbs.component.ts
@@ -1,33 +1,30 @@
-import { Component, OnDestroy } from "@angular/core";
-import { NavigationEnd, Router, UrlSegment } from "@angular/router";
-import { Subscription } from "rxjs";
+import { Component, OnDestroy } from '@angular/core';
+import { NavigationEnd, Router, UrlSegment } from '@angular/router';
+import { Subscription } from 'rxjs';
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: 'bread-crumbs',
templateUrl: 'breadCrumbs.component.html'
})
-
-export class BreadCrumbsComponent implements OnDestroy{
+export class BreadCrumbsComponent implements OnDestroy {
routeSubscription: Subscription;
routeArray?: string[];
- constructor(
- private router: Router
- ) {
- this.routeSubscription = this.router.events.subscribe((event: any) => {
+ constructor(private router: Router) {
+ this.routeSubscription = this.router.events.subscribe((event) => {
if (event instanceof NavigationEnd) {
this.routeArray = [];
- const tree: UrlSegment[] = this.router.parseUrl(event.url).root.children["primary"].segments;
- tree.map(segment => {
- this.routeArray?.push(segment.path);
+ const tree: UrlSegment[] = this.router.parseUrl(event.url).root.children['primary'].segments;
+ tree.map((segment) => {
+ this.routeArray?.push(segment.path);
});
}
});
}
navigate(index?: number) {
- if (!this.routeArray || !index && index !== 0) {
+ if (!this.routeArray || (!index && index !== 0)) {
this.router.navigate(['']);
return;
}
diff --git a/libs/common-docs/src/lib/common/construction-page/construction-page.component.html b/libs/common-docs/src/lib/common/construction-page/construction-page.component.html
index 6525edadc5..e8dd6b4b41 100644
--- a/libs/common-docs/src/lib/common/construction-page/construction-page.component.html
+++ b/libs/common-docs/src/lib/common/construction-page/construction-page.component.html
@@ -1,5 +1,8 @@
diff --git a/libs/common-docs/src/lib/common/discover/discover.component.html b/libs/common-docs/src/lib/common/discover/discover.component.html
index c47d084859..1cc92c2e38 100644
--- a/libs/common-docs/src/lib/common/discover/discover.component.html
+++ b/libs/common-docs/src/lib/common/discover/discover.component.html
@@ -3,28 +3,37 @@
@@ -38,41 +47,79 @@ Table of contents
Who is using ngx-bootstrap
- Some time ago, we've started to investigate companies, which using library ngx-bootstrap in
- their projects.
- We know, that for now, we have more than 60000 dependents, but
- let's see who are they:
+
+ Some time ago, we've started to investigate
+ companies, which using library ngx-bootstrap
+ in their projects.
+
+
+ We know, that for now, we have more than
+ 60000 dependents,
+ but let's see who are they:
+
-
-
+
+
- Versioning and Releases
- We make all possible to make ngx-bootstrap wide-compatible. Compatibility table you can find in the
documentation.
- All our issues , enhancements, feature requests, which would be taken into work first you can find in the nearest
Milestone.
+ Versioning and Releases
+
+ We make all possible to make ngx-bootstrap wide-compatible. Compatibility table you can find in the
+
documentation.
+
+
+ All our issues , enhancements, feature requests, which would be taken into work first you can find in the nearest
+
Milestone.
+
Changelog
- All notable changes are described in the CHANGELOG.md file.
+
+ All notable changes are described in the
+ CHANGELOG.md
+ file.
+
- Chat with us on Slack.
- For help using NGX-bootstrap, ask on StackOverflow using the tag ngx-bootstrap.
- Follow our core team member @valorkin on Twitter.
+
+ Chat with us on
+ Slack.
+
+
+ For help using NGX-bootstrap, ask on
+ StackOverflow using the tag
+ ngx-bootstrap.
+
+
+ Follow our core team member @valorkin on Twitter.
+
- If you also would like to show support or simply give back to Open Source community, please consider becoming a
- backer sponsor of ngx-bootstrap on OpenCollective.
+
+ If you also would like to show support or simply give back to Open Source community, please consider becoming a
+ backer sponsor of ngx-bootstrap on
+ OpenCollective.
+
diff --git a/libs/common-docs/src/lib/common/documentation/documentation.component.html b/libs/common-docs/src/lib/common/documentation/documentation.component.html
index 183b1d0a58..30a4a67c4a 100644
--- a/libs/common-docs/src/lib/common/documentation/documentation.component.html
+++ b/libs/common-docs/src/lib/common/documentation/documentation.component.html
@@ -4,28 +4,37 @@
@@ -33,8 +42,18 @@ Welcome to ngx-bootstrap!
Links
Table of contents
@@ -54,8 +73,10 @@
Getting Started
#
- ngx-bootstrap provides Bootstrap components powered by Angular, so you don't need to include original JS
- components.
+
+ ngx-bootstrap provides Bootstrap components powered by Angular, so you don't need to include original JS
+ components.
+
Check our Getting started guide if it's your first project with Angular Bootstrap.
@@ -73,17 +94,17 @@
ngx-bootstrap is an Open Source (MIT Licensed) project, it's an independent project with ongoing development
- made possible thanks to the support of our awesome backers.
- If you also would like to show support or simply give back to Open Source community, please consider becoming a
- backer sponsor of ngx-bootstrap on OpenCollective.
+ made possible thanks to the support of our awesome backers. If you also would like to show support or simply
+ give back to Open Source community, please consider becoming a backer sponsor of
+ ngx-bootstrap on OpenCollective.
All donated funds are managed transparently on OpenCollective and will be used solely for compensating work and
expenses for contributors. Valor Software employees and contractors are not eligible to use these funds.
- What's there for you? Proper recognition and exposure of your name/logo/website on our page.
- Our main sponsors will be presented under this section! Be the first!
+ What's there for you? Proper recognition and exposure of your name/logo/website on our page. Our main sponsors
+ will be presented under this section! Be the first!
@@ -91,9 +112,7 @@
Angular CLI way
-
- Use the Angular CLI ng add command for updating your Angular project.
-
+ Use the Angular CLI ng add command for updating your Angular project.
ng add ngx-bootstrap
Manual way
@@ -107,7 +126,7 @@ Manual way
class="pun">{{'}'}} from 'ngx-bootstrap/tooltip';
- @NgModule({{'{'}}
+ @NgModule({{'{'}}
…
imports: [ TooltipModule.forRoot(), … Manual way
<!--- index.html -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css""https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" integrity=Manual way
<!--- index.html -->
<link href="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css""https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/css/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" integrity=Manual way
Setting up the bootstrap version manually
As you may know ngx-bootstrap
support several bootstrap.css
versions at the same time
- and has automatic tool to
- guess current used version of library, but if this guess fails you can specify version of
+ and has automatic tool to guess current used version of library, but if this guess fails you can specify version
+ of
bootstrap.css
manually.
@@ -173,7 +192,7 @@ Setting up the bootstrap version manually
class="pln"> setTheme {{'}'}} from 'ngx-bootstrap/utils';
- @Component({{'{'}}…@Component({{'{'}}…{{'}'}})
export class AppComponent {{'{'}}
@@ -199,82 +218,85 @@
Compatibility
#
- The only two dependencies are Angular and Bootstrap CSS.
+
+ The only two dependencies are Angular and
+ Bootstrap CSS.
+
Here is the versions compatibility list:
-
- ngx-bootstrap |
- Angular |
- Bootstrap CSS |
-
+
+ ngx-bootstrap |
+ Angular |
+ Bootstrap CSS |
+
-
- 11.x.x |
- 16.x.x |
- 5.x.x or 4.x.x |
-
-
- 10.x.x |
- 15.x.x |
- 5.x.x or 4.x.x |
-
-
- 9.0.0 |
- 14.x.x |
- 5.x.x or 4.x.x or 3.x.x |
-
-
- 8.0.0 |
- 12.x.x - 13.x.x |
- 5.x.x or 4.x.x or 3.x.x |
-
-
- 7.1.0 |
- 11.x.x - 12.x.x |
- 5.x.x or 4.x.x or 3.x.x |
-
-
- 7.0.0 |
- 11.x.x - 12.x.x |
- 3.x.x or 4.x.x |
-
-
- 6.0.0 |
- 9.x.x - 10.x.x |
- 3.x.x or 4.x.x |
-
-
- 5.6.x |
- 7.x.x - 9.1.0 |
- 3.x.x or 4.x.x |
-
-
- 5.0.0 - 5.6.0 |
- 7.x.x - 8.x.x |
- 3.x.x or 4.x.x |
-
-
- 4.x.x |
- 6.x.x - 7.x.x |
- 3.x.x or 4.x.x |
-
-
- 3.x.x |
- 6.x.x - 7.x.x |
- 3.x.x or 4.x.x |
-
-
- 2.x.x |
- 2.x.x - 4.x.x |
- 3.x.x or 4.x.x |
-
-
- 1.x.x |
- 2.x.x |
- 3.x.x or 4.x.x |
-
+
+ 11.x.x |
+ 16.x.x |
+ 5.x.x or 4.x.x |
+
+
+ 10.x.x |
+ 15.x.x |
+ 5.x.x or 4.x.x |
+
+
+ 9.0.0 |
+ 14.x.x |
+ 5.x.x or 4.x.x or 3.x.x |
+
+
+ 8.0.0 |
+ 12.x.x - 13.x.x |
+ 5.x.x or 4.x.x or 3.x.x |
+
+
+ 7.1.0 |
+ 11.x.x - 12.x.x |
+ 5.x.x or 4.x.x or 3.x.x |
+
+
+ 7.0.0 |
+ 11.x.x - 12.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 6.0.0 |
+ 9.x.x - 10.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 5.6.x |
+ 7.x.x - 9.1.0 |
+ 3.x.x or 4.x.x |
+
+
+ 5.0.0 - 5.6.0 |
+ 7.x.x - 8.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 4.x.x |
+ 6.x.x - 7.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 3.x.x |
+ 6.x.x - 7.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 2.x.x |
+ 2.x.x - 4.x.x |
+ 3.x.x or 4.x.x |
+
+
+ 1.x.x |
+ 2.x.x |
+ 3.x.x or 4.x.x |
+
@@ -282,31 +304,53 @@
Troubleshooting
#
+ So if you are in trouble, here's where you can look for help.
- So if you are in trouble, here's where you can look for help.
+ The best place to ask questions is on
+ StackOverflow (under the ngx-bootstrap tag)
+ You can also join
+ our Slack channel
+ and link your stackoverflow question there. But try to avoid asking generic help questions directly on Slack
+ since they can easily get lost in the chat. You can also
+ search among the existing GitHub issues.
- The best place to ask questions is on StackOverflow (under the ngx-bootstrap tag) You can also join our Slack channel and link your stackoverflow question there. But try to avoid asking generic help questions directly on
- Slack since they can easily get lost in the chat. You can also search among the existing GitHub issues.
+ If, and only if, none of the above helped, please open a
+ new issue
- If, and only if, none of the above helped, please open a new issue
Contribution
#
- Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other
- developers to solve issues are very appreciated! Thanks in advance!
- Please read our contribution guidelines.
+
+ Are very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other
+ developers to solve issues are very appreciated! Thanks in advance!
+
+
+ Please read our
+ contribution guidelines.
+
Credits
#
- Crossbrowser testing sponsored by
+
+ Crossbrowser testing sponsored by
Saucelabs
-
+
diff --git a/libs/common-docs/src/lib/common/landing/landing.component.ts b/libs/common-docs/src/lib/common/landing/landing.component.ts
index 680b560797..07543fec72 100644
--- a/libs/common-docs/src/lib/common/landing/landing.component.ts
+++ b/libs/common-docs/src/lib/common/landing/landing.component.ts
@@ -3,7 +3,6 @@ import { AfterViewInit, Component } from '@angular/core';
import { Router } from '@angular/router';
-
@Component({
// eslint-disable-next-line @angular-eslint/component-selector
selector: 'landing',
@@ -12,20 +11,17 @@ import { Router } from '@angular/router';
export class LandingComponent implements AfterViewInit {
currentVersion?: string;
- constructor(
- private http: HttpClient,
- private router: Router
- ) {}
+ constructor(private http: HttpClient, private router: Router) {}
ngAfterViewInit(): void {
if (typeof window !== 'undefined') {
- this.http.get('assets/json/current-version.json').subscribe(data => {
- this.currentVersion = data.version;
+ this.http.get<{ version: string }>('assets/json/current-version.json').subscribe(({ version }) => {
+ this.currentVersion = version;
});
}
}
scrollToSection() {
- this.router.navigate(['.', 'documentation' ], {fragment: 'getting-started'});
+ this.router.navigate(['.', 'documentation'], { fragment: 'getting-started' });
}
}
diff --git a/libs/common-docs/src/lib/common/schematics/schematics.component.html b/libs/common-docs/src/lib/common/schematics/schematics.component.html
index 539ce91ca3..e3c89fbff3 100644
--- a/libs/common-docs/src/lib/common/schematics/schematics.component.html
+++ b/libs/common-docs/src/lib/common/schematics/schematics.component.html
@@ -4,49 +4,68 @@
-
- Schematics
-
+ Schematics
- The ngx-bootstrap library contains Angular Cli Schematics to allow easier installation. You can add ngx-bootstrap with one simple command.
+ The ngx-bootstrap library contains Angular Cli Schematics to allow easier installation. You can add
+ ngx-bootstrap with one simple command.
ng add ngx-bootstrap
- Alternative installation methods can be found there
+
+ Alternative installation methods can be found there
+
When you install ngx-bootstrap with Angular Cli Schematics you will get such updates:
- package.json
- List of dependencies will be updated with 2 new packages "bootstrap": "^5.2.3"
, "ngx-bootstrap": "10.x.x"
. After packages will be installed and node_modules folder will be updated also.
+ -
+
package.json
+
+ List of dependencies will be updated with 2 new packages "bootstrap": "^5.2.3"
,
+ "ngx-bootstrap": "10.x.x"
. After packages will be installed and node_modules folder will be
+ updated also.
+
- Depending on which style extension is used in the project, schematics will add necessary imports or styles links. It, as expected, allows the use SCSS or CSS extensions.
+ -
+
+ Depending on which style extension is used in the project, schematics will add necessary imports or styles
+ links. It, as expected, allows the use SCSS or CSS extensions.
+
In case CSS extension - angular.json
file will be updated.
"styles": [
@@ -55,22 +74,30 @@
…
]
- In case SCSS extension - for updating will be used main style file (standard ex. styles.scss
).
+
+ In case SCSS extension - for updating will be used main style file (standard ex. styles.scss
).
+
/* Importing Bootstrap SCSS file. */
-@import"~bootstrap/scss/bootstrap";
+@import"~bootstrap/scss/bootstrap";
/* Importing Datepicker SCSS file. */
-@import"node_modules/ngx-bootstrap/datepicker/bs-datepicker";
+@import"node_modules/ngx-bootstrap/datepicker/bs-datepicker";
- If the project will not have any style file or project will not have style files with available extensions - project will be updated with default CSS extension (first case).
+
+ If the project will not have any style file or project will not have style files with available extensions -
+ project will be updated with default CSS extension (first case).
+
-
-
The project's main module (standard ex. app.module.ts
) will be updated with import of BrowserAnimationsModule
, if it has not been previously imported.
+
+ The project's main module (standard ex. app.module.ts
) will be updated with import of
+ BrowserAnimationsModule
, if it has not been previously imported.
+
// added import of BrowserAnimationsModule to app.module.ts by ngx-bootstrap schematics
-import {{'{'}} BrowserAnimationsModule {{'}'}} from '@angular/platform-browser/animations';
+import {{'{'}} BrowserAnimationsModule {{'}'}} from '@angular/platform-browser/animations';
-@NgModule({{'{'}}
+@NgModule({{'{'}}
declarations: [
AppComponent
],
@@ -87,17 +114,25 @@
- ngx-bootstrap's ng add
schematic allows the easy installation. Additionally specific modules can be installed directly to a module with the following flag.
- ng add ngx-bootstrap --component accordion
+
+ ngx-bootstrap's ng add
schematic allows the easy installation. Additionally specific modules can be
+ installed directly to a module with the following flag.
+
+ ng add ngx-bootstrap --component accordion
Property component
accepts name of component which should be added into project.
-
-
If ngx-bootstrap has been installed previously, in this case will be updated only project's main file (standard ex. app.module.ts
)
+
+ If ngx-bootstrap has been installed previously, in this case will be updated only project's main file
+ (standard ex. app.module.ts
)
+
// added import of AccordionModule to app.module.ts by ngx-bootstrap schematics
import {{'{'}} AccordionModule {{'}'}} from 'ngx-bootstrap/accordion';
-@NgModule({{'{'}}
+@NgModule({{'{'}}
declarations: [
AppComponent
],
@@ -109,7 +144,9 @@
{{'}'}})
- - If library hasn't been installed before updates will include changes from Installation also.
+
-
+ If library hasn't been installed before updates will include changes from
+ Installation also.
All available values for property component
are:
- accordion
@@ -132,9 +169,16 @@
- Note: Styles for datepicker will be added only if you add all library or use property component
with datepicker
+
+ Note: Styles for datepicker will be added only if you add all library or use property
+ component
with datepicker
+
More information for each of the components you can find in Components.
- One more property which can be used with ngx-bootstrap schematics is stylesExtension
. This property accepts preferred style extension and update project regarding these use cases
+
+ One more property which can be used with ngx-bootstrap schematics is stylesExtension
. This property
+ accepts preferred style extension and update project regarding
+ these use cases
+
For more information ngx-bootstrap's schematics you can always use the help command
ng add ngx-bootstrap --help
diff --git a/libs/common-docs/src/lib/common/search-input/search-filter.pipe.ts b/libs/common-docs/src/lib/common/search-input/search-filter.pipe.ts
index 6ed11b3348..fbf188e343 100644
--- a/libs/common-docs/src/lib/common/search-input/search-filter.pipe.ts
+++ b/libs/common-docs/src/lib/common/search-input/search-filter.pipe.ts
@@ -1,17 +1,17 @@
import { Pipe, PipeTransform } from '@angular/core';
-import { Routes, Route } from '@angular/router';
+import { Route, Routes } from '@angular/router';
@Pipe({ name: 'SearchFilter' })
export class SearchFilterPipe implements PipeTransform {
- transform(value: Routes, text: any): any {
+ transform(value: Routes, text?: string): Routes {
if (!text) {
return value;
}
const items = value;
- const newItems: any = [];
+ const newItems: Routes = [];
- items.forEach(function(item: any): void {
+ items.forEach(function (item: Route): void {
if (!item.children?.length && item.data?.[0]?.toLowerCase().indexOf(text.toLowerCase()) !== -1) {
newItems.push(item);
}
diff --git a/libs/common-docs/src/lib/common/search-input/search-input.component.html b/libs/common-docs/src/lib/common/search-input/search-input.component.html
index 14f7a56fb3..9868237309 100644
--- a/libs/common-docs/src/lib/common/search-input/search-input.component.html
+++ b/libs/common-docs/src/lib/common/search-input/search-input.component.html
@@ -1,22 +1,26 @@