UIView | UI-Router
Options
All
  • Public
  • Public/Protected
  • All
Menu

A UI-Router viewport directive, which is filled in by a view (component) on a state.

Selector

A ui-view directive can be created as an element: <ui-view></ui-view> or as an attribute: <div ui-view></div>.

Purpose

This directive is used in a Component template (or as the root component) to create a viewport. The viewport is filled in by a view (as defined by a Ng2ViewDeclaration inside a Ng2StateDeclaration) when the view's state has been activated.

example

// This app has two states, 'foo' and 'bar'
stateRegistry.register({ name: 'foo', url: '/foo', component: FooComponent });
stateRegistry.register({ name: 'bar', url: '/bar', component: BarComponent });
<!-- This ui-view will be filled in by the foo state's component or
     the bar state's component when the foo or bar state is activated -->
<ui-view></ui-view>

Named ui-views

A ui-view may optionally be given a name via the attribute value: <div ui-view='header'></div>. Note: an unnamed ui-view is internally named $default. When a ui-view has a name, it will be filled in by a matching named view.

example

stateRegistry.register({
  name: 'foo',
  url: '/foo',
  views: { header: HeaderComponent, $default: FooComponent });
<!-- When 'foo' state is active, filled by HeaderComponent -->
<div ui-view="header"></div>

<!-- When 'foo' state is active, filled by FooComponent -->
<ui-view></ui-view>

Hierarchy

  • UIView

Index

Constructors

Properties

componentRef: ComponentRef<any>
componentTarget: ViewContainerRef
deregister: Function
name: string
router: UIRouter
uiViewData: ActiveUIView
viewContainerRef: ViewContainerRef
PARENT_INJECT: string

Accessors

  • set (val: string): void

Methods

  • applyInputBindings(ref: ComponentRef<any>, context: ResolveContext, componentClass: any): void
  • Supplies component inputs with resolve data

  • Supplies component inputs with resolve data

    Finds component inputs which match resolves (by name) and sets the input value to the resolve data.

    Parameters

    Returns void


  • disposeLast(): void
  • getComponentInjector(context: ResolveContext): Injector
  • Creates a new Injector for a routed component.

  • Creates a new Injector for a routed component.

    Adds resolve values to the Injector Adds providers from the NgModule for the state Adds providers from the parent Component in the component tree Adds a PARENT_INJECT view context object

    Parameters

    Returns Injector

    :

    an Injector


  • ngOnDestroy(): void
  • ngOnInit(): void
  • viewConfigUpdated(config: ViewConfig): void
  • The view service is informing us of an updated ViewConfig (usually because a transition activated some state and its views)

  • The view service is informing us of an updated ViewConfig (usually because a transition activated some state and its views)

    Parameters

    Returns void


Generated using TypeDoc