Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IModalSettings

Index

Properties

Optional animation

animation: boolean

Set to false to disable animations on new modal/backdrop. Does not toggle animations for modals/backdrops that are already displayed.

default

true

Optional appendTo

Appends the modal to a specific element.

default

'body'

Optional ariaDescribedBy

ariaDescribedBy: string

Sets the aria-describedby property on the modal. The string should be an id (without the leading '#') pointing to the element that describes your modal.

memberof

IModalSettings

Optional ariaLabelledBy

ariaLabelledBy: string

Sets the aria-labelledby property on the modal. The string should be an id (without the leading '#') pointing to the element that labels your modal.

memberof

IModalSettings

Optional backdrop

backdrop: string | boolean

controls the presence of a backdrop Allowed values:

  • true (default)
  • false (no backdrop)
  • 'static' backdrop is present but modal window is not closed when clicking outside of the modal window
default

true

Optional backdropClass

backdropClass: string

additional CSS class(es) to be added to a modal backdrop template

Optional bindToController

bindToController: boolean

When used with controllerAs and set to true, it will bind the controller properties onto the $scope directly.

default

false

Optional component

component: string

A string reference to the component to be rendered that is registered with Angular's compiler. If using a directive, the directive must have restrict: 'E' and a template or templateUrl set.

It supports these bindings:

  • close - A method that can be used to close a modal, passing a result. The result must be passed in this format: {$value: myResult}
  • dismiss - A method that can be used to dismiss a modal, passing a result. The result must be passed in this format: {$value: myRejectedResult}
  • modalInstance - The modal instance. This is the same $uibModalInstance injectable found when using controller.
  • resolve - An object of the modal resolve values. See [UI Router resolves] for details.

Optional controller

controller: string | Function | (string | Function)[]

a controller for a modal instance - it can initialize scope used by modal. A controller can be injected with $modalInstance If value is an array, it must be in Inline Array Annotation format for injection (strings followed by factory method)

Optional controllerAs

controllerAs: string

an alternative to the controller-as syntax, matching the API of directive definitions. Requires the controller option to be provided as well

Optional keyboard

keyboard: boolean

indicates whether the dialog should be closable by hitting the ESC key

default

true

Optional openedClass

openedClass: string

The class added to the body element when the modal is opened.

default

'model-open'

Optional resolve

resolve: {}

members that will be resolved and passed to the controller as locals; it is equivalent of the resolve property for AngularJS routes If property value is an array, it must be in Inline Array Annotation format for injection (strings followed by factory method)

Type declaration

  • [key: string]: string | Function | (string | Function)[] | Object

Optional scope

a scope instance to be used for the modal's content (actually the $modal service is going to create a child scope of a provided scope). Defaults to $rootScope.

Optional size

size: string

Optional suffix of modal window class. The value used is appended to the modal- class, i.e. a value of sm gives modal-sm.

Optional template

template: string | (() => string)

inline template representing the modal's content

Optional templateUrl

templateUrl: string | (() => string)

a path to a template representing modal's content

Optional windowClass

windowClass: string

additional CSS class(es) to be added to a modal window template

Optional windowTemplateUrl

windowTemplateUrl: string

a path to a template overriding modal's window template

Optional windowTopClass

windowTopClass: string

CSS class(es) to be added to the top modal window.

Generated using TypeDoc