Class/Object

scala.scalajs.js.annotation

JSImport

Related Docs: object JSImport | package annotation

Permalink

class JSImport extends Annotation with StaticAnnotation

Marks the annotated class or object as imported from another JS module.

Intuitively, this corresponds to ECMAScript import directives. See the documentation of the various constructors.

@JSImport is not compatible with the jsDependencies mechanism offered by the Scala.js sbt plugin. You are responsible for resolving and/or bundling the JavaScript modules that you are importing using other mechanisms.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JSImport
  2. StaticAnnotation
  3. Annotation
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JSImport(module: String, name: Namespace.type, globalFallback: String)

    Permalink

    Namespace import (import the module itself), with a fallback on a global variable.

    Namespace import (import the module itself), with a fallback on a global variable.

    When linking with module support, this is equivalent to @JSImport(module, name).

    When linking without module support, this is equivalent to @JSGlobal(globalFallback).

  2. new JSImport(module: String, name: String, globalFallback: String)

    Permalink

    Named import of a member of the module, with a fallback on a global variable.

    Named import of a member of the module, with a fallback on a global variable.

    When linking with module support, this is equivalent to @JSImport(module, name).

    When linking without module support, this is equivalent to @JSGlobal(globalFallback).

  3. new JSImport(module: String, name: Namespace.type)

    Permalink

    Namespace import (import the module itself).

    Namespace import (import the module itself).

    The second parameter should be the singleton JSImport.Namespace.

    Intuitively, this corresponds to

    import * as AnnotatedObject from <module>
  4. new JSImport(module: String, name: String)

    Permalink

    Named import of a member of the module.

    Named import of a member of the module.

    Intuitively, this corresponds to the following ECMAScript import directive:

    import { <name> as AnnotatedClassOrObject } from <module>

    To import the default export of a module, use JSImport.Default as name.

Value Members

  1. final def !=(arg0: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to any2stringadd[JSImport] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (JSImport, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to ArrowAssoc[JSImport] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (JSImport) ⇒ Boolean, msg: ⇒ scala.Any): JSImport

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (JSImport) ⇒ Boolean): JSImport

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ scala.Any): JSImport

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): JSImport

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to Ensuring[JSImport] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: scala.Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to StringFormat[JSImport] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (JSImport, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from JSImport to ArrowAssoc[JSImport] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from AnyRef

Inherited from scala.Any

Inherited by implicit conversion any2stringadd from JSImport to any2stringadd[JSImport]

Inherited by implicit conversion StringFormat from JSImport to StringFormat[JSImport]

Inherited by implicit conversion Ensuring from JSImport to Ensuring[JSImport]

Inherited by implicit conversion ArrowAssoc from JSImport to ArrowAssoc[JSImport]

Ungrouped