const API_DOCS = { "NgbAccordionConfig": { "fileName": "src/accordion/accordion-config.ts", "className": "NgbAccordionConfig", "description": "Configuration service for the NgbAccordion component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the accordions used in the application.", "methods": [], "properties": [ { "name": "closeOthers", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "type", "type": "string", "description": "" } ] }, "NgbPanelTitle": { "fileName": "src/accordion/accordion.ts", "className": "NgbPanelTitle", "description": "This directive should be used to wrap accordion panel titles that need to contain HTML markup or other directives.", "selector": "ng-template[ngbPanelTitle]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbPanelContent": { "fileName": "src/accordion/accordion.ts", "className": "NgbPanelContent", "description": "This directive must be used to wrap accordion panel content.", "selector": "ng-template[ngbPanelContent]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbPanel": { "fileName": "src/accordion/accordion.ts", "className": "NgbPanel", "description": "The NgbPanel directive represents an individual panel with the title and collapsible\r\ncontent", "selector": "ngb-panel", "inputs": [ { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "A flag determining whether the panel is disabled or not.\r\nWhen disabled, the panel cannot be toggled." }, { "name": "id", "type": "string", "description": "An optional id for the panel. The id should be unique.\r\nIf not provided, it will be auto-generated." }, { "name": "title", "type": "string", "description": "The title for the panel." }, { "name": "type", "type": "string", "description": "Accordion's types of panels to be applied per panel basis.\r\nBootstrap 4 recognizes the following types: \"success\", \"info\", \"warning\" and \"danger\"." } ], "outputs": [], "properties": [ { "name": "contentTpl", "type": "NgbPanelContent", "description": "" }, { "name": "titleTpl", "type": "NgbPanelTitle", "description": "" } ], "methods": [] }, "NgbPanelChangeEvent": { "fileName": "src/accordion/accordion.ts", "className": "NgbPanelChangeEvent", "description": "The payload of the change event fired right before toggling an accordion panel", "methods": [], "properties": [ { "name": "nextState", "type": "boolean", "description": "Whether the panel will be opened (true) or closed (false)" }, { "name": "panelId", "type": "string", "description": "Id of the accordion panel that is toggled" }, { "name": "preventDefault", "type": "() => void", "description": "Function that will prevent panel toggling if called" } ] }, "NgbAccordion": { "fileName": "src/accordion/accordion.ts", "className": "NgbAccordion", "description": "The NgbAccordion directive is a collection of panels.\r\nIt can assure that only one panel can be opened at a time.", "selector": "ngb-accordion", "exportAs": "ngbAccordion", "inputs": [ { "name": "activeIds", "type": "string | string[]", "description": "An array or comma separated strings of panel identifiers that should be opened" }, { "name": "closeOthers", "type": "boolean", "description": "Whether the other panels should be closed when a panel is opened" }, { "name": "type", "type": "string", "description": "Accordion's types of panels to be applied globally.\r\nBootstrap 4 recognizes the following types: \"success\", \"info\", \"warning\" and \"danger\"." } ], "outputs": [ { "name": "panelChange", "description": "A panel change event fired right before the panel toggle happens. See NgbPanelChangeEvent for payload details" } ], "properties": [ { "name": "panels", "type": "QueryList", "description": "" } ], "methods": [ { "name": "toggle", "description": "Programmatically toggle a panel with a given id.", "args": [ { "name": "panelId", "type": "string" } ], "returnType": "void" } ] }, "NgbAlertConfig": { "fileName": "src/alert/alert-config.ts", "className": "NgbAlertConfig", "description": "Configuration service for the NgbAlert component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the alerts used in the application.", "methods": [], "properties": [ { "name": "dismissible", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "type", "defaultValue": "warning", "type": "string", "description": "" } ] }, "NgbAlert": { "fileName": "src/alert/alert.ts", "className": "NgbAlert", "description": "Alerts can be used to provide feedback messages.", "selector": "ngb-alert", "inputs": [ { "name": "dismissible", "type": "boolean", "description": "A flag indicating if a given alert can be dismissed (closed) by a user. If this flag is set, a close button (in a\r\nform of an ×) will be displayed." }, { "name": "type", "type": "string", "description": "Alert type (CSS class). Bootstrap 4 recognizes the following types: \"success\", \"info\", \"warning\" and \"danger\"." } ], "outputs": [ { "name": "close", "description": "An event emitted when the close button is clicked. This event has no payload. Only relevant for dismissible alerts." } ], "properties": [], "methods": [] }, "NgbRadioGroup": { "fileName": "src/buttons/radio.ts", "className": "NgbRadioGroup", "description": "Easily create Bootstrap-style radio buttons. A value of a selected button is bound to a variable\r\nspecified via ngModel.", "selector": "[ngbRadioGroup]", "inputs": [], "outputs": [], "properties": [ { "name": "disabled", "type": "boolean", "description": "" }, { "name": "onChange", "type": "(_: any) => void", "description": "" }, { "name": "onTouched", "type": "() => void", "description": "" } ], "methods": [] }, "NgbActiveLabel": { "fileName": "src/buttons/radio.ts", "className": "NgbActiveLabel", "description": "", "selector": "label.btn", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbRadio": { "fileName": "src/buttons/radio.ts", "className": "NgbRadio", "description": "Marks an input of type \"radio\" as part of the NgbRadioGroup.", "selector": "input[type=radio]", "inputs": [ { "name": "checked", "type": "boolean", "description": "A flag indicating if a given radio button is checked." }, { "name": "disabled", "type": "boolean", "description": "A flag indicating if a given radio button is disabled." }, { "name": "value", "type": "any", "description": "You can specify model value of a given radio by binding to the value property." } ], "outputs": [], "properties": [ { "name": "checked", "type": "boolean", "description": "A flag indicating if a given radio button is checked." }, { "name": "disabled", "type": "boolean", "description": "A flag indicating if a given radio button is disabled." }, { "name": "value", "type": "any", "description": "You can specify model value of a given radio by binding to the value property." } ], "methods": [] }, "NgbCarouselConfig": { "fileName": "src/carousel/carousel-config.ts", "className": "NgbCarouselConfig", "description": "Configuration service for the NgbCarousel component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the carousels used in the application.", "methods": [], "properties": [ { "name": "interval", "defaultValue": "5000", "type": "number", "description": "" }, { "name": "keyboard", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "wrap", "defaultValue": "true", "type": "boolean", "description": "" } ] }, "NgbSlide": { "fileName": "src/carousel/carousel.ts", "className": "NgbSlide", "description": "Represents an individual slide to be used within a carousel.", "selector": "ng-template[ngbSlide]", "inputs": [ { "name": "id", "type": "string", "description": "Unique slide identifier. Must be unique for the entire document for proper accessibility support.\r\nWill be auto-generated if not provided." } ], "outputs": [], "properties": [], "methods": [] }, "NgbCarousel": { "fileName": "src/carousel/carousel.ts", "className": "NgbCarousel", "description": "Directive to easily create carousels based on Bootstrap's markup.", "selector": "ngb-carousel", "exportAs": "ngbCarousel", "inputs": [ { "name": "activeId", "type": "string", "description": "The active slide id." }, { "name": "interval", "type": "number", "description": "Amount of time in milliseconds before next slide is shown." }, { "name": "keyboard", "type": "boolean", "description": "A flag for allowing navigation via keyboard" }, { "name": "wrap", "type": "boolean", "description": "Whether can wrap from the last to the first slide." } ], "outputs": [], "properties": [ { "name": "slides", "type": "QueryList", "description": "" } ], "methods": [ { "name": "select", "description": "Navigate to a slide with the specified identifier.", "args": [ { "name": "slideId", "type": "string" } ], "returnType": "void" }, { "name": "prev", "description": "Navigate to the next slide.", "args": [], "returnType": "void" }, { "name": "next", "description": "Navigate to the next slide.", "args": [], "returnType": "void" }, { "name": "pause", "description": "Stops the carousel from cycling through items.", "args": [], "returnType": "void" }, { "name": "cycle", "description": "Restarts cycling through the carousel slides from left to right.", "args": [], "returnType": "void" } ] }, "NgbCollapse": { "fileName": "src/collapse/collapse.ts", "className": "NgbCollapse", "description": "The NgbCollapse directive provides a simple way to hide and show an element with animations.", "selector": "[ngbCollapse]", "exportAs": "ngbCollapse", "inputs": [ { "name": "ngbCollapse", "defaultValue": "false", "type": "boolean", "description": "A flag indicating collapsed (true) or open (false) state." } ], "outputs": [], "properties": [], "methods": [] }, "NgbDatepickerConfig": { "fileName": "src/datepicker/datepicker-config.ts", "className": "NgbDatepickerConfig", "description": "Configuration service for the NgbDatepicker component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the datepickers used in the application.", "methods": [], "properties": [ { "name": "dayTemplate", "type": "TemplateRef", "description": "" }, { "name": "displayMonths", "defaultValue": "1", "type": "number", "description": "" }, { "name": "firstDayOfWeek", "defaultValue": "1", "type": "number", "description": "" }, { "name": "markDisabled", "type": "(date: NgbDateStruct, current: { year: number; month: number; }) => boolean", "description": "" }, { "name": "maxDate", "type": "NgbDateStruct", "description": "" }, { "name": "minDate", "type": "NgbDateStruct", "description": "" }, { "name": "navigation", "defaultValue": "select", "type": "\"select\" | \"arrows\" | \"none\"", "description": "" }, { "name": "outsideDays", "defaultValue": "visible", "type": "\"visible\" | \"collapsed\" | \"hidden\"", "description": "" }, { "name": "showWeekdays", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "showWeekNumbers", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "startDate", "type": "{ year: number; month: number; }", "description": "" } ] }, "DayTemplateContext": { "fileName": "src/datepicker/datepicker-day-template-context.ts", "className": "DayTemplateContext", "description": "Context for the datepicker 'day' template in case you want to override the default one", "methods": [], "properties": [ { "name": "currentMonth", "type": "number", "description": "Month currently displayed by the datepicker" }, { "name": "date", "type": "NgbDateStruct", "description": "Date that corresponds to the template" }, { "name": "disabled", "type": "boolean", "description": "True if current date is disabled" }, { "name": "selected", "type": "boolean", "description": "True if current date is selected" } ] }, "NgbDatepickerDayView": { "fileName": "src/datepicker/datepicker-day-view.ts", "className": "NgbDatepickerDayView", "description": "", "selector": "[ngbDatepickerDayView]", "inputs": [ { "name": "currentMonth", "type": "number", "description": "" }, { "name": "date", "type": "NgbDateStruct", "description": "" }, { "name": "disabled", "type": "boolean", "description": "" }, { "name": "selected", "type": "boolean", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "NgbDatepickerI18n": { "fileName": "src/datepicker/datepicker-i18n.ts", "className": "NgbDatepickerI18n", "description": "Type of the service supplying month and weekday names to to NgbDatepicker component.\r\nSee the i18n demo for how to extend this class and define a custom provider for i18n.", "methods": [ { "name": "getWeekdayShortName", "description": "Returns the short weekday name to display in the heading of the month view.\r\nWith default calendar we use ISO 8601: 'weekday' is 1=Mon ... 7=Sun", "args": [ { "name": "weekday", "type": "number" } ], "returnType": "string" }, { "name": "getMonthShortName", "description": "Returns the short month name to display in the date picker navigation.\r\nWith default calendar we use ISO 8601: 'month' is 1=Jan ... 12=Dec", "args": [ { "name": "month", "type": "number" } ], "returnType": "string" }, { "name": "getMonthFullName", "description": "Returns the full month name to display in the date picker navigation.\r\nWith default calendar we use ISO 8601: 'month' is 1=January ... 12=December", "args": [ { "name": "month", "type": "number" } ], "returnType": "string" } ], "properties": [] }, "NgbDatepickerI18nDefault": { "fileName": "src/datepicker/datepicker-i18n.ts", "className": "NgbDatepickerI18nDefault", "description": "", "methods": [], "properties": [] }, "NgbInputDatepicker": { "fileName": "src/datepicker/datepicker-input.ts", "className": "NgbInputDatepicker", "description": "A directive that makes it possible to have datepickers on input fields.\r\nManages integration with the input field itself (data entry) and ngModel (validation etc.).", "selector": "input[ngbDatepicker]", "exportAs": "ngbDatepicker", "inputs": [ { "name": "dayTemplate", "type": "TemplateRef", "description": "Reference for the custom template for the day display" }, { "name": "displayMonths", "type": "number", "description": "Number of months to display" }, { "name": "firstDayOfWeek", "type": "number", "description": "First day of the week. With default calendar we use ISO 8601: 1=Mon ... 7=Sun" }, { "name": "markDisabled", "type": "(date: NgbDateStruct, current: { year: number; month: number; }) => boolean", "description": "Callback to mark a given date as disabled.\r\n'Current' contains the month that will be displayed in the view" }, { "name": "maxDate", "type": "NgbDateStruct", "description": "Max date for the navigation. If not provided will be 10 years from today or `startDate`" }, { "name": "minDate", "type": "NgbDateStruct", "description": "Min date for the navigation. If not provided will be 10 years before today or `startDate`" }, { "name": "navigation", "type": "\"select\" | \"arrows\" | \"none\"", "description": "Navigation type: `select` (default with select boxes for month and year), `arrows`\r\n(without select boxes, only navigation arrows) or `none` (no navigation at all)" }, { "name": "outsideDays", "type": "\"visible\" | \"collapsed\" | \"hidden\"", "description": "The way to display days that don't belong to current month: `visible` (default),\r\n`hidden` (not displayed) or `collapsed` (not displayed with empty space collapsed)" }, { "name": "showWeekdays", "type": "boolean", "description": "Whether to display days of the week" }, { "name": "showWeekNumbers", "type": "boolean", "description": "Whether to display week numbers" }, { "name": "startDate", "type": "{ year: number; month: number; }", "description": "Date to open calendar with.\r\nWith default calendar we use ISO 8601: 'month' is 1=Jan ... 12=Dec.\r\nIf nothing or invalid date provided, calendar will open with current month.\r\nUse 'navigateTo(date)' as an alternative" } ], "outputs": [ { "name": "navigate", "description": "An event fired when navigation happens and currently displayed month changes.\r\nSee NgbDatepickerNavigateEvent for the payload info." } ], "properties": [], "methods": [ { "name": "open", "description": "Opens the datepicker with the selected date indicated by the ngModel value.", "args": [], "returnType": "void" }, { "name": "close", "description": "Closes the datepicker popup.", "args": [], "returnType": "void" }, { "name": "toggle", "description": "Toggles the datepicker popup (opens when closed and closes when opened).", "args": [], "returnType": "void" }, { "name": "navigateTo", "description": "Navigates current view to provided date.\r\nWith default calendar we use ISO 8601: 'month' is 1=Jan ... 12=Dec.\r\nIf nothing or invalid date provided calendar will open current month.\r\nUse 'startDate' input as an alternative", "args": [ { "name": "date", "type": "{ year: number; month: number; }" } ], "returnType": "void" } ] }, "NgbDatepickerMonthView": { "fileName": "src/datepicker/datepicker-month-view.ts", "className": "NgbDatepickerMonthView", "description": "", "selector": "ngb-datepicker-month-view", "inputs": [ { "name": "dayTemplate", "type": "TemplateRef", "description": "" }, { "name": "disabled", "type": "boolean", "description": "" }, { "name": "month", "type": "MonthViewModel", "description": "" }, { "name": "outsideDays", "type": "\"visible\" | \"collapsed\" | \"hidden\"", "description": "" }, { "name": "selectedDate", "type": "NgbDate", "description": "" }, { "name": "showWeekdays", "type": "any", "description": "" }, { "name": "showWeekNumbers", "type": "any", "description": "" } ], "outputs": [ { "name": "select", "description": "" } ], "properties": [], "methods": [] }, "NgbDatepickerNavigationSelect": { "fileName": "src/datepicker/datepicker-navigation-select.ts", "className": "NgbDatepickerNavigationSelect", "description": "", "selector": "ngb-datepicker-navigation-select", "inputs": [ { "name": "date", "type": "NgbDate", "description": "" }, { "name": "disabled", "type": "boolean", "description": "" }, { "name": "maxDate", "type": "NgbDate", "description": "" }, { "name": "minDate", "type": "NgbDate", "description": "" } ], "outputs": [ { "name": "select", "description": "" } ], "properties": [ { "name": "months", "type": "number[]", "description": "" }, { "name": "years", "type": "number[]", "description": "" } ], "methods": [] }, "NgbDatepickerNavigation": { "fileName": "src/datepicker/datepicker-navigation.ts", "className": "NgbDatepickerNavigation", "description": "", "selector": "ngb-datepicker-navigation", "inputs": [ { "name": "date", "type": "NgbDate", "description": "" }, { "name": "disabled", "type": "boolean", "description": "" }, { "name": "maxDate", "type": "NgbDate", "description": "" }, { "name": "minDate", "type": "NgbDate", "description": "" }, { "name": "months", "type": "number", "description": "" }, { "name": "showSelect", "type": "boolean", "description": "" }, { "name": "showWeekNumbers", "type": "boolean", "description": "" } ], "outputs": [ { "name": "navigate", "description": "" }, { "name": "select", "description": "" } ], "properties": [ { "name": "navigation", "defaultValue": "NavigationEvent", "type": "typeof NavigationEvent", "description": "" } ], "methods": [] }, "NgbDatepickerService": { "fileName": "src/datepicker/datepicker-service.ts", "className": "NgbDatepickerService", "description": "", "methods": [], "properties": [] }, "NgbDatepickerNavigateEvent": { "fileName": "src/datepicker/datepicker.ts", "className": "NgbDatepickerNavigateEvent", "description": "The payload of the datepicker navigation event", "methods": [], "properties": [ { "name": "current", "type": "{ year: number; month: number; }", "description": "Currently displayed month" }, { "name": "next", "type": "{ year: number; month: number; }", "description": "Month we're navigating to" } ] }, "NgbDatepicker": { "fileName": "src/datepicker/datepicker.ts", "className": "NgbDatepicker", "description": "A lightweight and highly configurable datepicker directive", "selector": "ngb-datepicker", "exportAs": "ngbDatepicker", "inputs": [ { "name": "dayTemplate", "type": "TemplateRef", "description": "Reference for the custom template for the day display" }, { "name": "displayMonths", "type": "number", "description": "Number of months to display" }, { "name": "firstDayOfWeek", "type": "number", "description": "First day of the week. With default calendar we use ISO 8601: 'weekday' is 1=Mon ... 7=Sun" }, { "name": "markDisabled", "type": "(date: NgbDateStruct, current: { year: number; month: number; }) => boolean", "description": "Callback to mark a given date as disabled.\r\n'Current' contains the month that will be displayed in the view" }, { "name": "maxDate", "type": "NgbDateStruct", "description": "Max date for the navigation. If not provided will be 10 years from today or `startDate`" }, { "name": "minDate", "type": "NgbDateStruct", "description": "Min date for the navigation. If not provided will be 10 years before today or `startDate`" }, { "name": "navigation", "type": "\"select\" | \"arrows\" | \"none\"", "description": "Navigation type: `select` (default with select boxes for month and year), `arrows`\r\n(without select boxes, only navigation arrows) or `none` (no navigation at all)" }, { "name": "outsideDays", "type": "\"visible\" | \"collapsed\" | \"hidden\"", "description": "The way to display days that don't belong to current month: `visible` (default),\r\n`hidden` (not displayed) or `collapsed` (not displayed with empty space collapsed)" }, { "name": "showWeekdays", "type": "boolean", "description": "Whether to display days of the week" }, { "name": "showWeekNumbers", "type": "boolean", "description": "Whether to display week numbers" }, { "name": "startDate", "type": "{ year: number; month: number; }", "description": "Date to open calendar with.\r\nWith default calendar we use ISO 8601: 'month' is 1=Jan ... 12=Dec.\r\nIf nothing or invalid date provided, calendar will open with current month.\r\nUse 'navigateTo(date)' as an alternative" } ], "outputs": [ { "name": "navigate", "description": "An event fired when navigation happens and currently displayed month changes.\r\nSee NgbDatepickerNavigateEvent for the payload info." } ], "properties": [ { "name": "_date", "type": "NgbDate", "description": "" }, { "name": "_maxDate", "type": "NgbDate", "description": "" }, { "name": "_minDate", "type": "NgbDate", "description": "" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "model", "type": "NgbDate", "description": "" }, { "name": "months", "type": "MonthViewModel[]", "description": "" }, { "name": "onChange", "type": "(_: any) => void", "description": "" }, { "name": "onTouched", "type": "() => void", "description": "" } ], "methods": [ { "name": "navigateTo", "description": "Navigates current view to provided date.\r\nWith default calendar we use ISO 8601: 'month' is 1=Jan ... 12=Dec.\r\nIf nothing or invalid date provided calendar will open current month.\r\nUse 'startDate' input as an alternative", "args": [ { "name": "date", "type": "{ year: number; month: number; }" } ], "returnType": "void" } ] }, "NgbCalendarHijri": { "fileName": "src/datepicker/hijri/ngb-calendar-hijri.ts", "className": "NgbCalendarHijri", "description": "", "methods": [ { "name": "fromGregorian", "description": "Returns the equivalent Hijri date value for a give input Gregorian date.\r\n`gDate` is s JS Date to be converted to Hijri.", "args": [ { "name": "gDate", "type": "Date" } ], "returnType": "NgbDate" }, { "name": "toGregorian", "description": "Converts the current Hijri date to Gregorian.", "args": [ { "name": "hijriDate", "type": "NgbDate" } ], "returnType": "Date" }, { "name": "getDaysInIslamicMonth", "description": "Returns the number of days in a specific Hijri month.\r\n`month` is 1 for Muharram, 2 for Safar, etc.\r\n`year` is any Hijri year.", "args": [ { "name": "month", "type": "number" }, { "name": "year", "type": "number" } ], "returnType": "number" }, { "name": "_getMonthStart", "description": "Returns the start of Hijri Month.\r\n`month` is 0 for Muharram, 1 for Safar, etc.\r\n`year` is any Hijri year.", "args": [ { "name": "year", "type": "number" }, { "name": "month", "type": "number" } ], "returnType": "number" }, { "name": "_getYearStart", "description": "Returns the start of Hijri year.\r\n`year` is any Hijri year.", "args": [ { "name": "year", "type": "number" } ], "returnType": "number" } ], "properties": [] }, "NgbCalendarIslamicCivil": { "fileName": "src/datepicker/hijri/ngb-calendar-islamic-civil.ts", "className": "NgbCalendarIslamicCivil", "description": "", "methods": [ { "name": "fromGregorian", "description": "Returns the equivalent islamic(civil) date value for a give input Gregorian date.\r\n`gdate` is a JS Date to be converted to Hijri.", "args": [ { "name": "gdate", "type": "Date" } ], "returnType": "NgbDate" }, { "name": "toGregorian", "description": "Returns the equivalent JS date value for a give input islamic(civil) date.\r\n`hijriDate` is an islamic(civil) date to be converted to Gregorian.", "args": [ { "name": "hijriDate", "type": "NgbDate" } ], "returnType": "Date" }, { "name": "getDaysInIslamicMonth", "description": "Returns the number of days in a specific Hijri month.\r\n`month` is 1 for Muharram, 2 for Safar, etc.\r\n`year` is any Hijri year.", "args": [ { "name": "month", "type": "number" }, { "name": "year", "type": "number" } ], "returnType": "number" } ], "properties": [] }, "NgbCalendar": { "fileName": "src/datepicker/ngb-calendar.ts", "className": "NgbCalendar", "description": "", "methods": [], "properties": [] }, "NgbCalendarGregorian": { "fileName": "src/datepicker/ngb-calendar.ts", "className": "NgbCalendarGregorian", "description": "", "methods": [], "properties": [] }, "NgbDateParserFormatter": { "fileName": "src/datepicker/ngb-date-parser-formatter.ts", "className": "NgbDateParserFormatter", "description": "Abstract type serving as a DI token for the service parsing and formatting dates for the NgbInputDatepicker\r\ndirective. A default implementation using the ISO 8601 format is provided, but you can provide another implementation\r\nto use an alternative format.", "methods": [ { "name": "parse", "description": "Parses the given value to an NgbDateStruct. Implementations should try their best to provide a result, even\r\npartial. They must return null if the value can't be parsed.", "args": [ { "name": "value", "type": "string" } ], "returnType": "NgbDateStruct" }, { "name": "format", "description": "Formats the given date to a string. Implementations should return an empty string if the given date is null,\r\nand try their best to provide a partial result if the given date is incomplete or invalid.", "args": [ { "name": "date", "type": "NgbDateStruct" } ], "returnType": "string" } ], "properties": [] }, "NgbDateStruct": { "fileName": "src/datepicker/ngb-date-struct.ts", "className": "NgbDateStruct", "description": "Interface of the model of the NgbDatepicker and NgbInputDatepicker directives", "methods": [], "properties": [ { "name": "day", "type": "number", "description": "The day of month, starting at 1" }, { "name": "month", "type": "number", "description": "The month, with default calendar we use ISO 8601: 1=Jan ... 12=Dec" }, { "name": "year", "type": "number", "description": "The year, for example 2016" } ] }, "NgbDropdownConfig": { "fileName": "src/dropdown/dropdown-config.ts", "className": "NgbDropdownConfig", "description": "Configuration service for the NgbDropdown directive.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the dropdowns used in the application.", "methods": [], "properties": [ { "name": "autoClose", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "up", "defaultValue": "false", "type": "boolean", "description": "" } ] }, "NgbDropdown": { "fileName": "src/dropdown/dropdown.ts", "className": "NgbDropdown", "description": "Transforms a node into a dropdown.", "selector": "[ngbDropdown]", "exportAs": "ngbDropdown", "inputs": [ { "name": "autoClose", "type": "boolean", "description": "Indicates that dropdown should be closed when selecting one of dropdown items (click) or pressing ESC." }, { "name": "open", "defaultValue": "false", "type": "boolean", "description": "Defines whether or not the dropdown-menu is open initially." }, { "name": "up", "type": "boolean", "description": "Indicates that the dropdown should open upwards" } ], "outputs": [ { "name": "openChange", "description": "An event fired when the dropdown is opened or closed.\r\nEvent's payload equals whether dropdown is open." } ], "properties": [], "methods": [ { "name": "isOpen", "description": "Checks if the dropdown menu is open or not.", "args": [], "returnType": "boolean" }, { "name": "open", "description": "Opens the dropdown menu of a given navbar or tabbed navigation.", "args": [], "returnType": "void" }, { "name": "close", "description": "Closes the dropdown menu of a given navbar or tabbed navigation.", "args": [], "returnType": "void" }, { "name": "toggle", "description": "Toggles the dropdown menu of a given navbar or tabbed navigation.", "args": [], "returnType": "void" } ] }, "NgbDropdownToggle": { "fileName": "src/dropdown/dropdown.ts", "className": "NgbDropdownToggle", "description": "Allows the dropdown to be toggled via click. This directive is optional.", "selector": "[ngbDropdownToggle]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbModalBackdrop": { "fileName": "src/modal/modal-backdrop.ts", "className": "NgbModalBackdrop", "description": "", "selector": "ngb-modal-backdrop", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbActiveModal": { "fileName": "src/modal/modal-ref.ts", "className": "NgbActiveModal", "description": "A reference to an active (currently opened) modal. Instances of this class\r\ncan be injected into components passed as modal content.", "methods": [ { "name": "close", "description": "Can be used to close a modal, passing an optional result.", "args": [ { "name": "result", "type": "any" } ], "returnType": "void" }, { "name": "dismiss", "description": "Can be used to dismiss a modal, passing an optional reason.", "args": [ { "name": "reason", "type": "any" } ], "returnType": "void" } ], "properties": [] }, "NgbModalRef": { "fileName": "src/modal/modal-ref.ts", "className": "NgbModalRef", "description": "A reference to a newly opened modal.", "methods": [ { "name": "close", "description": "Can be used to close a modal, passing an optional result.", "args": [ { "name": "result", "type": "any" } ], "returnType": "void" }, { "name": "dismiss", "description": "Can be used to dismiss a modal, passing an optional reason.", "args": [ { "name": "reason", "type": "any" } ], "returnType": "void" } ], "properties": [ { "name": "componentInstance", "type": "any", "description": "The instance of component used as modal's content.\r\nUndefined when a TemplateRef is used as modal's content." }, { "name": "result", "type": "Promise", "description": "A promise that is resolved when a modal is closed and rejected when a modal is dismissed." } ] }, "NgbModalStack": { "fileName": "src/modal/modal-stack.ts", "className": "NgbModalStack", "description": "", "methods": [], "properties": [] }, "NgbModalWindow": { "fileName": "src/modal/modal-window.ts", "className": "NgbModalWindow", "description": "", "selector": "ngb-modal-window", "inputs": [ { "name": "backdrop", "defaultValue": "true", "type": "string | boolean", "description": "" }, { "name": "keyboard", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "size", "type": "string", "description": "" }, { "name": "windowClass", "type": "string", "description": "" } ], "outputs": [ { "name": "dismiss", "description": "" } ], "properties": [], "methods": [] }, "NgbModalOptions": { "fileName": "src/modal/modal.ts", "className": "NgbModalOptions", "description": "Represent options available when opening new modal windows.", "methods": [], "properties": [ { "name": "backdrop", "type": "boolean | \"static\"", "description": "Whether a backdrop element should be created for a given modal (true by default).\r\nAlternatively, specify 'static' for a backdrop which doesn't close the modal on click." }, { "name": "container", "type": "string", "description": "An element to which to attach newly opened modal windows." }, { "name": "keyboard", "type": "boolean", "description": "Whether to close the modal when escape key is pressed (true by default)." }, { "name": "size", "type": "\"sm\" | \"lg\"", "description": "Size of a new modal window." }, { "name": "windowClass", "type": "string", "description": "Custom class to append to the modal window" } ] }, "NgbModal": { "fileName": "src/modal/modal.ts", "className": "NgbModal", "description": "A service to open modal windows. Creating a modal is straightforward: create a template and pass it as an argument to\r\nthe \"open\" method!", "methods": [ { "name": "open", "description": "Opens a new modal window with the specified content and using supplied options. Content can be provided\r\nas a TemplateRef or a component type. If you pass a component type as content than instances of those\r\ncomponents can be injected with an instance of the NgbActiveModal class. You can use methods on the\r\nNgbActiveModal class to close / dismiss modals from \"inside\" of a component.", "args": [ { "name": "content", "type": "any" }, { "name": "options", "type": "NgbModalOptions" } ], "returnType": "NgbModalRef" } ], "properties": [] }, "NgbPaginationConfig": { "fileName": "src/pagination/pagination-config.ts", "className": "NgbPaginationConfig", "description": "Configuration service for the NgbPagination component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the paginations used in the application.", "methods": [], "properties": [ { "name": "boundaryLinks", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "directionLinks", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "ellipses", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "maxSize", "defaultValue": "0", "type": "number", "description": "" }, { "name": "pageSize", "defaultValue": "10", "type": "number", "description": "" }, { "name": "rotate", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "size", "type": "\"sm\" | \"lg\"", "description": "" } ] }, "NgbPagination": { "fileName": "src/pagination/pagination.ts", "className": "NgbPagination", "description": "A directive that will take care of visualising a pagination bar and enable / disable buttons correctly!", "selector": "ngb-pagination", "inputs": [ { "name": "boundaryLinks", "type": "boolean", "description": "Whether to show the \"First\" and \"Last\" page links" }, { "name": "collectionSize", "type": "number", "description": "Number of items in collection." }, { "name": "directionLinks", "type": "boolean", "description": "Whether to show the \"Next\" and \"Previous\" page links" }, { "name": "disabled", "type": "boolean", "description": "Whether to disable buttons from user input" }, { "name": "ellipses", "type": "boolean", "description": "Whether to show ellipsis symbols and first/last page numbers when maxSize > number of pages" }, { "name": "maxSize", "type": "number", "description": "Maximum number of pages to display." }, { "name": "page", "defaultValue": "0", "type": "number", "description": "Current page." }, { "name": "pageSize", "type": "number", "description": "Number of items per page." }, { "name": "rotate", "type": "boolean", "description": "Whether to rotate pages when maxSize > number of pages.\r\nCurrent page will be in the middle" }, { "name": "size", "type": "\"sm\" | \"lg\"", "description": "Pagination display size: small or large" } ], "outputs": [ { "name": "pageChange", "description": "An event fired when the page is changed.\r\nEvent's payload equals to the newly selected page." } ], "properties": [ { "name": "pageCount", "defaultValue": "0", "type": "number", "description": "" }, { "name": "pages", "type": "number[]", "description": "" } ], "methods": [] }, "NgbPopoverConfig": { "fileName": "src/popover/popover-config.ts", "className": "NgbPopoverConfig", "description": "Configuration service for the NgbPopover directive.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the popovers used in the application.", "methods": [], "properties": [ { "name": "container", "type": "string", "description": "" }, { "name": "placement", "defaultValue": "top", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "" }, { "name": "triggers", "defaultValue": "click", "type": "string", "description": "" } ] }, "NgbPopoverWindow": { "fileName": "src/popover/popover.ts", "className": "NgbPopoverWindow", "description": "", "selector": "ngb-popover-window", "inputs": [ { "name": "id", "type": "string", "description": "" }, { "name": "placement", "defaultValue": "top", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "" }, { "name": "title", "type": "string", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "NgbPopover": { "fileName": "src/popover/popover.ts", "className": "NgbPopover", "description": "A lightweight, extensible directive for fancy popover creation.", "selector": "[ngbPopover]", "exportAs": "ngbPopover", "inputs": [ { "name": "container", "type": "string", "description": "A selector specifying the element the popover should be appended to.\r\nCurrently only supports \"body\"." }, { "name": "ngbPopover", "type": "string | TemplateRef", "description": "Content to be displayed as popover." }, { "name": "placement", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "Placement of a popover. Accepts: \"top\", \"bottom\", \"left\", \"right\"" }, { "name": "popoverTitle", "type": "string", "description": "Title of a popover." }, { "name": "triggers", "type": "string", "description": "Specifies events that should trigger. Supports a space separated list of event names." } ], "outputs": [ { "name": "hidden", "description": "Emits an event when the popover is hidden" }, { "name": "shown", "description": "Emits an event when the popover is shown" } ], "properties": [], "methods": [ { "name": "open", "description": "Opens an element’s popover. This is considered a “manual” triggering of the popover.\r\nThe context is an optional value to be injected into the popover template when it is created.", "args": [ { "name": "context", "type": "any" } ], "returnType": "void" }, { "name": "close", "description": "Closes an element’s popover. This is considered a “manual” triggering of the popover.", "args": [], "returnType": "void" }, { "name": "toggle", "description": "Toggles an element’s popover. This is considered a “manual” triggering of the popover.", "args": [], "returnType": "void" }, { "name": "isOpen", "description": "Returns whether or not the popover is currently being shown", "args": [], "returnType": "boolean" } ] }, "NgbProgressbarConfig": { "fileName": "src/progressbar/progressbar-config.ts", "className": "NgbProgressbarConfig", "description": "Configuration service for the NgbProgressbar component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the progress bars used in the application.", "methods": [], "properties": [ { "name": "animated", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "max", "defaultValue": "100", "type": "number", "description": "" }, { "name": "showValue", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "striped", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "type", "type": "string", "description": "" } ] }, "NgbProgressbar": { "fileName": "src/progressbar/progressbar.ts", "className": "NgbProgressbar", "description": "Directive that can be used to provide feedback on the progress of a workflow or an action.", "selector": "ngb-progressbar", "inputs": [ { "name": "animated", "type": "boolean", "description": "A flag indicating if the stripes of the progress bar should be animated. Takes effect only for browsers\r\nsupporting CSS3 animations, and if striped is true." }, { "name": "max", "type": "number", "description": "Maximal value to be displayed in the progressbar." }, { "name": "showValue", "type": "boolean", "description": "A flag indicating if the current percentage value should be shown." }, { "name": "striped", "type": "boolean", "description": "A flag indicating if a progress bar should be displayed as striped." }, { "name": "type", "type": "string", "description": "Type of progress bar, can be one of \"success\", \"info\", \"warning\" or \"danger\"." }, { "name": "value", "defaultValue": "0", "type": "number", "description": "Current value to be displayed in the progressbar. Should be smaller or equal to \"max\" value." } ], "outputs": [], "properties": [], "methods": [] }, "NgbRatingConfig": { "fileName": "src/rating/rating-config.ts", "className": "NgbRatingConfig", "description": "Configuration service for the NgbRating component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the ratings used in the application.", "methods": [], "properties": [ { "name": "max", "defaultValue": "10", "type": "number", "description": "" }, { "name": "readonly", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "resettable", "defaultValue": "false", "type": "boolean", "description": "" } ] }, "StarTemplateContext": { "fileName": "src/rating/rating.ts", "className": "StarTemplateContext", "description": "Context for the custom star display template", "methods": [], "properties": [ { "name": "fill", "type": "number", "description": "Star fill percentage. An integer value between 0 and 100" } ] }, "NgbRating": { "fileName": "src/rating/rating.ts", "className": "NgbRating", "description": "Rating directive that will take care of visualising a star rating bar.", "selector": "ngb-rating", "inputs": [ { "name": "max", "type": "number", "description": "Maximal rating that can be given using this widget." }, { "name": "rate", "type": "number", "description": "Current rating. Can be a decimal value like 3.75" }, { "name": "readonly", "type": "boolean", "description": "A flag indicating if rating can be updated." }, { "name": "resettable", "type": "boolean", "description": "A flag indicating if rating can be reset to 0 on mouse click" }, { "name": "starTemplate", "type": "TemplateRef", "description": "A template to override star display.\r\nAlternatively put a as the only child of element" } ], "outputs": [ { "name": "hover", "description": "An event fired when a user is hovering over a given rating.\r\nEvent's payload equals to the rating being hovered over." }, { "name": "leave", "description": "An event fired when a user stops hovering over a given rating.\r\nEvent's payload equals to the rating of the last item being hovered over." }, { "name": "rateChange", "description": "An event fired when a user selects a new rating.\r\nEvent's payload equals to the newly selected rating." } ], "properties": [ { "name": "contexts", "type": "StarTemplateContext[]", "description": "" }, { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "nextRate", "type": "number", "description": "" }, { "name": "onChange", "type": "(_: any) => void", "description": "" }, { "name": "onTouched", "type": "() => void", "description": "" } ], "methods": [] }, "NgbTabsetConfig": { "fileName": "src/tabset/tabset-config.ts", "className": "NgbTabsetConfig", "description": "Configuration service for the NgbTabset component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the tabsets used in the application.", "methods": [], "properties": [ { "name": "justify", "defaultValue": "start", "type": "\"start\" | \"center\" | \"end\"", "description": "" }, { "name": "type", "defaultValue": "tabs", "type": "\"tabs\" | \"pills\"", "description": "" } ] }, "NgbTabTitle": { "fileName": "src/tabset/tabset.ts", "className": "NgbTabTitle", "description": "This directive should be used to wrap tab titles that need to contain HTML markup or other directives.", "selector": "ng-template[ngbTabTitle]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbTabContent": { "fileName": "src/tabset/tabset.ts", "className": "NgbTabContent", "description": "This directive must be used to wrap content to be displayed in a tab.", "selector": "ng-template[ngbTabContent]", "inputs": [], "outputs": [], "properties": [], "methods": [] }, "NgbTab": { "fileName": "src/tabset/tabset.ts", "className": "NgbTab", "description": "A directive representing an individual tab.", "selector": "ngb-tab", "inputs": [ { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "Allows toggling disabled state of a given state. Disabled tabs can't be selected." }, { "name": "id", "type": "string", "description": "Unique tab identifier. Must be unique for the entire document for proper accessibility support." }, { "name": "title", "type": "string", "description": "Simple (string only) title. Use the \"NgbTabTitle\" directive for more complex use-cases." } ], "outputs": [], "properties": [ { "name": "contentTpl", "type": "NgbTabContent", "description": "" }, { "name": "titleTpl", "type": "NgbTabTitle", "description": "" } ], "methods": [] }, "NgbTabChangeEvent": { "fileName": "src/tabset/tabset.ts", "className": "NgbTabChangeEvent", "description": "The payload of the change event fired right before the tab change", "methods": [], "properties": [ { "name": "activeId", "type": "string", "description": "Id of the currently active tab" }, { "name": "nextId", "type": "string", "description": "Id of the newly selected tab" }, { "name": "preventDefault", "type": "() => void", "description": "Function that will prevent tab switch if called" } ] }, "NgbTabset": { "fileName": "src/tabset/tabset.ts", "className": "NgbTabset", "description": "A component that makes it easy to create tabbed interface.", "selector": "ngb-tabset", "exportAs": "ngbTabset", "inputs": [ { "name": "activeId", "type": "string", "description": "An identifier of an initially selected (active) tab. Use the \"select\" method to switch a tab programmatically." }, { "name": "destroyOnHide", "defaultValue": "true", "type": "boolean", "description": "Whether the closed tabs should be hidden without destroying them" }, { "name": "justify", "type": "\"start\" | \"center\" | \"end\"", "description": "The horizontal alignment of the nav with flexbox utilities. Can be one of 'start', 'center' or 'end'" }, { "name": "type", "type": "\"tabs\" | \"pills\"", "description": "Type of navigation to be used for tabs. Can be one of 'tabs' or 'pills'." } ], "outputs": [ { "name": "tabChange", "description": "A tab change event fired right before the tab selection happens. See NgbTabChangeEvent for payload details" } ], "properties": [ { "name": "tabs", "type": "QueryList", "description": "" } ], "methods": [ { "name": "select", "description": "Selects the tab with the given id and shows its associated pane.\r\nAny other tab that was previously selected becomes unselected and its associated pane is hidden.", "args": [ { "name": "tabId", "type": "string" } ], "returnType": "void" } ] }, "NgbTimeStruct": { "fileName": "src/timepicker/ngb-time-struct.ts", "className": "NgbTimeStruct", "description": "Interface of the model of the NgbTimepicker directive", "methods": [], "properties": [ { "name": "hour", "type": "number", "description": "The hour, going from 0 to 23" }, { "name": "minute", "type": "number", "description": "The minute, going from 0 to 59" }, { "name": "second", "type": "number", "description": "The second, going from 0 to 59" } ] }, "NgbTimepickerConfig": { "fileName": "src/timepicker/timepicker-config.ts", "className": "NgbTimepickerConfig", "description": "Configuration service for the NgbTimepicker component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the timepickers used in the application.", "methods": [], "properties": [ { "name": "disabled", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "hourStep", "defaultValue": "1", "type": "number", "description": "" }, { "name": "meridian", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "minuteStep", "defaultValue": "1", "type": "number", "description": "" }, { "name": "readonlyInputs", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "seconds", "defaultValue": "false", "type": "boolean", "description": "" }, { "name": "secondStep", "defaultValue": "1", "type": "number", "description": "" }, { "name": "size", "defaultValue": "medium", "type": "\"small\" | \"medium\" | \"large\"", "description": "" }, { "name": "spinners", "defaultValue": "true", "type": "boolean", "description": "" } ] }, "NgbTimepicker": { "fileName": "src/timepicker/timepicker.ts", "className": "NgbTimepicker", "description": "A lightweight & configurable timepicker directive.", "selector": "ngb-timepicker", "inputs": [ { "name": "hourStep", "type": "number", "description": "Number of hours to increase or decrease when using a button." }, { "name": "meridian", "type": "boolean", "description": "Whether to display 12H or 24H mode." }, { "name": "minuteStep", "type": "number", "description": "Number of minutes to increase or decrease when using a button." }, { "name": "readonlyInputs", "type": "boolean", "description": "To make timepicker readonly" }, { "name": "seconds", "type": "boolean", "description": "Whether to display seconds input." }, { "name": "secondStep", "type": "number", "description": "Number of seconds to increase or decrease when using a button." }, { "name": "size", "type": "\"small\" | \"medium\" | \"large\"", "description": "To set the size of the inputs and button" }, { "name": "spinners", "type": "boolean", "description": "Whether to display the spinners above and below the inputs." } ], "outputs": [], "properties": [ { "name": "disabled", "type": "boolean", "description": "" }, { "name": "model", "type": "NgbTime", "description": "" }, { "name": "onChange", "type": "(_: any) => void", "description": "" }, { "name": "onTouched", "type": "() => void", "description": "" } ], "methods": [] }, "NgbTooltipConfig": { "fileName": "src/tooltip/tooltip-config.ts", "className": "NgbTooltipConfig", "description": "Configuration service for the NgbTooltip directive.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the tooltips used in the application.", "methods": [], "properties": [ { "name": "container", "type": "string", "description": "" }, { "name": "placement", "defaultValue": "top", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "" }, { "name": "triggers", "defaultValue": "hover", "type": "string", "description": "" } ] }, "NgbTooltipWindow": { "fileName": "src/tooltip/tooltip.ts", "className": "NgbTooltipWindow", "description": "", "selector": "ngb-tooltip-window", "inputs": [ { "name": "id", "type": "string", "description": "" }, { "name": "placement", "defaultValue": "top", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "" } ], "outputs": [], "properties": [], "methods": [] }, "NgbTooltip": { "fileName": "src/tooltip/tooltip.ts", "className": "NgbTooltip", "description": "A lightweight, extensible directive for fancy tooltip creation.", "selector": "[ngbTooltip]", "exportAs": "ngbTooltip", "inputs": [ { "name": "container", "type": "string", "description": "A selector specifying the element the tooltip should be appended to.\r\nCurrently only supports \"body\"." }, { "name": "ngbTooltip", "type": "string | TemplateRef", "description": "Content to be displayed as tooltip. If falsy, the tooltip won't open." }, { "name": "placement", "type": "\"top\" | \"bottom\" | \"left\" | \"right\"", "description": "Placement of a tooltip. Accepts: \"top\", \"bottom\", \"left\", \"right\"" }, { "name": "triggers", "type": "string", "description": "Specifies events that should trigger. Supports a space separated list of event names." } ], "outputs": [ { "name": "hidden", "description": "Emits an event when the tooltip is hidden" }, { "name": "shown", "description": "Emits an event when the tooltip is shown" } ], "properties": [ { "name": "ngbTooltip", "type": "string | TemplateRef", "description": "Content to be displayed as tooltip. If falsy, the tooltip won't open." } ], "methods": [ { "name": "open", "description": "Opens an element’s tooltip. This is considered a “manual” triggering of the tooltip.\r\nThe context is an optional value to be injected into the tooltip template when it is created.", "args": [ { "name": "context", "type": "any" } ], "returnType": "void" }, { "name": "close", "description": "Closes an element’s tooltip. This is considered a “manual” triggering of the tooltip.", "args": [], "returnType": "void" }, { "name": "toggle", "description": "Toggles an element’s tooltip. This is considered a “manual” triggering of the tooltip.", "args": [], "returnType": "void" }, { "name": "isOpen", "description": "Returns whether or not the tooltip is currently being shown", "args": [], "returnType": "boolean" } ] }, "NgbHighlight": { "fileName": "src/typeahead/highlight.ts", "className": "NgbHighlight", "description": "", "selector": "ngb-highlight", "inputs": [ { "name": "highlightClass", "defaultValue": "ngb-highlight", "type": "string", "description": "" }, { "name": "result", "type": "string", "description": "" }, { "name": "term", "type": "string", "description": "" } ], "outputs": [], "properties": [ { "name": "parts", "type": "string[]", "description": "" } ], "methods": [] }, "NgbTypeaheadConfig": { "fileName": "src/typeahead/typeahead-config.ts", "className": "NgbTypeaheadConfig", "description": "Configuration service for the NgbTypeahead component.\r\nYou can inject this service, typically in your root component, and customize the values of its properties in\r\norder to provide default values for all the typeaheads used in the application.", "methods": [], "properties": [ { "name": "editable", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "focusFirst", "defaultValue": "true", "type": "boolean", "description": "" }, { "name": "showHint", "defaultValue": "false", "type": "boolean", "description": "" } ] }, "ResultTemplateContext": { "fileName": "src/typeahead/typeahead-window.ts", "className": "ResultTemplateContext", "description": "Context for the typeahead result template in case you want to override the default one", "methods": [], "properties": [ { "name": "result", "type": "any", "description": "Your typeahead result data model" }, { "name": "term", "type": "string", "description": "Search term from the input used to get current result" } ] }, "NgbTypeaheadWindow": { "fileName": "src/typeahead/typeahead-window.ts", "className": "NgbTypeaheadWindow", "description": "", "selector": "ngb-typeahead-window", "exportAs": "ngbTypeaheadWindow", "inputs": [ { "name": "focusFirst", "defaultValue": "true", "type": "boolean", "description": "Flag indicating if the first row should be active initially" }, { "name": "formatter", "defaultValue": "toString", "type": "(value: any) => string", "description": "A function used to format a given result before display. This function should return a formatted string without any\r\nHTML markup" }, { "name": "id", "type": "string", "description": "The id for the typeahead widnow. The id should be unique and the same\r\nas the associated typeahead's id." }, { "name": "results", "type": "any", "description": "Typeahead match results to be displayed" }, { "name": "resultTemplate", "type": "TemplateRef", "description": "A template to override a matching result default display" }, { "name": "term", "type": "string", "description": "Search term used to get current results" } ], "outputs": [ { "name": "activeChange", "description": "" }, { "name": "select", "description": "Event raised when user selects a particular result row" } ], "properties": [ { "name": "activeIdx", "defaultValue": "0", "type": "number", "description": "" } ], "methods": [] }, "NgbTypeaheadSelectItemEvent": { "fileName": "src/typeahead/typeahead.ts", "className": "NgbTypeaheadSelectItemEvent", "description": "Payload of the selectItem event.", "methods": [], "properties": [ { "name": "item", "type": "any", "description": "An item about to be selected" }, { "name": "preventDefault", "type": "() => void", "description": "Function that will prevent item selection if called" } ] }, "NgbTypeahead": { "fileName": "src/typeahead/typeahead.ts", "className": "NgbTypeahead", "description": "NgbTypeahead directive provides a simple way of creating powerful typeaheads from any text input", "selector": "input[ngbTypeahead]", "inputs": [ { "name": "editable", "type": "boolean", "description": "A flag indicating if model values should be restricted to the ones selected from the popup only." }, { "name": "focusFirst", "type": "boolean", "description": "A flag indicating if the first match should automatically be focused as you type." }, { "name": "inputFormatter", "type": "(value: any) => string", "description": "A function to convert a given value into string to display in the input field" }, { "name": "ngbTypeahead", "type": "(text: Observable) => Observable", "description": "A function to transform the provided observable text into the array of results. Note that the \"this\" argument\r\nis undefined so you need to explicitly bind it to a desired \"this\" target." }, { "name": "resultFormatter", "type": "(value: any) => string", "description": "A function to format a given result before display. This function should return a formatted string without any\r\nHTML markup" }, { "name": "resultTemplate", "type": "TemplateRef", "description": "A template to override a matching result default display" }, { "name": "showHint", "type": "boolean", "description": "Show hint when an option in the result list matches." } ], "outputs": [ { "name": "selectItem", "description": "An event emitted when a match is selected. Event payload is of type NgbTypeaheadSelectItemEvent." } ], "properties": [ { "name": "activeDescendant", "type": "string", "description": "" }, { "name": "popupId", "type": "string", "description": "" } ], "methods": [] } }; export default API_DOCS;