Visibility enum

Options for configuring whether a directive class can be injected.

See Directive.visibility for details including the default behavior.

Inheritance

Constructors

Visibility()
const

Values

local → const Visibility

The directive can only be injected "locally"; i.e. not from another view.

For example, the following code will fail at runtime:

@Component(
  selector: 'parent',
  directives: const [Child],
  template: '<child></child>',

  // The default, but here explicitly for clarity.
  visibility: Visibility.local,
)
class Parent {}

@Component(
  selector: 'child',
  template: '',
)
class Child {
  // Will throw runtime error: "No provider found for Parent".
  Child(Parent parent);
}

However, if the Parent and Child components are in the same view, the example works:

@Component(
  selector: 'parent',
  template: '',

  // The default, but here explicitly for clarity.
  visibility: Visibility.local,
)
class Parent {}

@Component(
  selector: 'child',
  template: '',
)
class Child {
  // Will successfully inject the `Parent` instance.
  Child(Parent parent);
}

@Component(
  selector: 'app',
  directives: const [Child, Parent],
  template: '''
    <parent>
      <child></child>
    </parent>
  ''',
)
class App {}

Similarly, directives on the same host (including a component) can inject each other regardless of visibility.

Furthermore, it is possible to provide another interface to children:

// An interface that will be provided by the Parent class.
abstract class Example {}

@Component(
  selector: 'parent',
  directives: const [Child],
  providers: const [
    const ExistingProvider(Example, useExisting: Parent),
  ],
  template: '<child></child>',
)

class Parent implements Example {}

@Component( selector: 'child', template: '', ) class Child { // Fine! Child(Example example); }


... like all uses of `providers: const [ ... ]`, this increases the cost
of the component or directive, and should only be added when injection
is truly needed, similar to [Visibility.all].

**NOTE**: We intend to allow other forms of dependency injection (such as
`FactoryProvider` to also access "local" components and directives, but
this does not yet work: https://github.com/angulardart/angular/issues/716.
all → const Visibility

The directive can be injected anywhere in the sub tree.

@Component(
  selector: 'parent',
  directives: const [Child],
  template: '<child></child>',
  visibility: Visibility.all,
)
class Parent {}

@Component(
  selector: 'child',
  template: '',
)
class Child {
  Child(Parent parent);
}

Semantically, this is similar to providing yourself to this instance.

NOTE: If the component or directive class is not meant to be injected by a child this will have additional code-size and runtime cost that is not useful to the application, and Visibility.local is then preferred.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<Visibility>
A constant List of the values in this enum, in order of their declaration.