Class View<TEvent, TNative, TProps>

Type Parameters

TEvent extends string = ViewEvents
TNative = any
TProps extends IViewProps = IViewProps

Hierarchy

default<TEvent | ViewEvents, TNative, TProps>
- View

Index

Properties

`Protected` _nativeObject

_nativeObject: any

`Static` iOS

iOS: { SemanticContentAttribute: typeof SemanticContentAttribute } = ...

iOS Specific Properties.

Since

3.1.3

Type declaration

SemanticContentAttribute: typeof SemanticContentAttribute

`Static` Events

Events: { Touch: "touch"; TouchCancelled: "touchCancelled"; TouchEnded: "touchEnded"; TouchMoved: "touchMoved" } = ViewEvents

Type declaration

Touch: "touch"
TouchCancelled: "touchCancelled"
TouchEnded: "touchEnded"
TouchMoved: "touchMoved"

`Static` Border

Border: typeof Border = Border

Accessors

nativeObject

get nativeObject(): any
Returns any
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:11
set nativeObject(value: any): void
Parameters
- value: any
Returns void
Inherited from NativeEventEmitterComponent.nativeObject
- Defined in core/native-component.ts:15

ios

get ios(): TProps["ios"]
Returns TProps["ios"]
Inherited from NativeEventEmitterComponent.ios
- Defined in core/native-mobile-component.ts:49

android

get android(): TProps["android"]
Returns TProps["android"]
Inherited from NativeEventEmitterComponent.android
- Defined in core/native-mobile-component.ts:52

Methods

`Protected` preConstruct

preConstruct(params?: Partial<Record<string, any>>): void
Parameters
- Optional params: Partial<Record<string, any>>
Returns void
Inherited from NativeEventEmitterComponent.preConstruct
- Defined in core/native-event-emitter-component.ts:27

`Protected` addAndroidProps

addAndroidProps(props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["android"]): void
Parameters
- props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["android"]
Returns void
Inherited from NativeEventEmitterComponent.addAndroidProps
- Defined in core/native-mobile-component.ts:43

`Protected` addIOSProps

addIOSProps(props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["ios"]): void
Parameters
- props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["ios"]
Returns void
Inherited from NativeEventEmitterComponent.addIOSProps
- Defined in core/native-mobile-component.ts:46

`Protected` createNativeObject

createNativeObject(): any
Returns any
Overrides NativeEventEmitterComponent.createNativeObject
- Defined in ui/view/view.ts:1140

on

on(eventName: "touch", callback: ((e: Point2D) => void)): (() => void)
Parameters
- eventName: "touch"
- callback: ((e: Point2D) => void)
  - - (e: Point2D): void
    - Parameters
      
      e: Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1157
on(eventName: "touchEnded", callback: ((e: { isInside: boolean } & Point2D) => void)): (() => void)
Parameters
- eventName: "touchEnded"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1158
on(eventName: "touchMoved", callback: ((e: { isInside: boolean } & Point2D) => void)): (() => void)
Parameters
- eventName: "touchMoved"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1159
on(eventName: "touchCancelled", callback: ((point: Point2D) => boolean)): (() => void)
Parameters
- eventName: "touchCancelled"
- callback: ((point: Point2D) => boolean)
  - - (point: Point2D): boolean
    - Parameters
      
      point: Point2D
      
      Returns boolean
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1160
on(eventName: TEvent, callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: TEvent
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1161
on(eventName: "touch" | "touchCancelled" | "touchEnded" | "touchMoved", callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: "touch" | "touchCancelled" | "touchEnded" | "touchMoved"
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.on
- Defined in ui/view/view.ts:1162

off

off(eventName: "touch", callback: ((e: Point2D) => void)): void
Parameters
- eventName: "touch"
- callback: ((e: Point2D) => void)
  - - (e: Point2D): void
    - Parameters
      
      e: Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/view/view.ts:1167
off(eventName: "touchEnded", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchEnded"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/view/view.ts:1168
off(eventName: "touchMoved", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchMoved"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/view/view.ts:1169
off(eventName: "touchCancelled", callback: ((point: Point2D) => boolean)): void
Parameters
- eventName: "touchCancelled"
- callback: ((point: Point2D) => boolean)
  - - (point: Point2D): boolean
    - Parameters
      
      point: Point2D
      
      Returns boolean
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/view/view.ts:1170
off(eventName: TEvent, callback: ((...args: any[]) => void)): void
Parameters
- eventName: TEvent
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.off
- Defined in ui/view/view.ts:1171

emit

emit(eventName: "touch", point: Point2D): void
Parameters
- eventName: "touch"
- point: Point2D
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/view/view.ts:1176
emit(eventName: "touchEnded", params: { isInside: boolean } & Point2D): void
Parameters
- eventName: "touchEnded"
- params: { isInside: boolean } & Point2D
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/view/view.ts:1177
emit(eventName: "touchMoved", params: { isInside: boolean } & Point2D): void
Parameters
- eventName: "touchMoved"
- params: { isInside: boolean } & Point2D
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/view/view.ts:1178
emit(eventName: "touchCancelled", point: Point2D): void
Parameters
- eventName: "touchCancelled"
- point: Point2D
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/view/view.ts:1179
emit(eventName: TEvent, ...args: any[]): void
Parameters
- eventName: TEvent
- Rest ...args: any[]
Returns void
Overrides NativeEventEmitterComponent.emit
- Defined in ui/view/view.ts:1180

once

once(eventName: "touch", callback: ((e: Point2D) => void)): (() => void)
Parameters
- eventName: "touch"
- callback: ((e: Point2D) => void)
  - - (e: Point2D): void
    - Parameters
      
      e: Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/view/view.ts:1185
once(eventName: "touchEnded", callback: ((e: { isInside: boolean } & Point2D) => void)): (() => void)
Parameters
- eventName: "touchEnded"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/view/view.ts:1186
once(eventName: "touchMoved", callback: ((e: { isInside: boolean } & Point2D) => void)): (() => void)
Parameters
- eventName: "touchMoved"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/view/view.ts:1187
once(eventName: "touchCancelled", callback: ((point: Point2D) => boolean)): (() => void)
Parameters
- eventName: "touchCancelled"
- callback: ((point: Point2D) => boolean)
  - - (point: Point2D): boolean
    - Parameters
      
      point: Point2D
      
      Returns boolean
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/view/view.ts:1188
once(eventName: TEvent, callback: ((...args: any[]) => void)): (() => void)
Parameters
- eventName: TEvent
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns (() => void)
- - (): void
  - Returns void
Overrides NativeEventEmitterComponent.once
- Defined in ui/view/view.ts:1189

prependListener

prependListener(eventName: "touch", callback: ((e: Point2D) => void)): void
Parameters
- eventName: "touch"
- callback: ((e: Point2D) => void)
  - - (e: Point2D): void
    - Parameters
      
      e: Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/view/view.ts:1194
prependListener(eventName: "touchEnded", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchEnded"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/view/view.ts:1195
prependListener(eventName: "touchMoved", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchMoved"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/view/view.ts:1196
prependListener(eventName: "touchCancelled", callback: ((point: Point2D) => boolean)): void
Parameters
- eventName: "touchCancelled"
- callback: ((point: Point2D) => boolean)
  - - (point: Point2D): boolean
    - Parameters
      
      point: Point2D
      
      Returns boolean
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/view/view.ts:1197
prependListener(eventName: TEvent, callback: ((...args: any[]) => void)): void
Parameters
- eventName: TEvent
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependListener
- Defined in ui/view/view.ts:1198

prependOnceListener

prependOnceListener(eventName: "touch", callback: ((e: Point2D) => void)): void
Parameters
- eventName: "touch"
- callback: ((e: Point2D) => void)
  - - (e: Point2D): void
    - Parameters
      
      e: Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/view/view.ts:1203
prependOnceListener(eventName: "touchEnded", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchEnded"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/view/view.ts:1204
prependOnceListener(eventName: "touchMoved", callback: ((e: { isInside: boolean } & Point2D) => void)): void
Parameters
- eventName: "touchMoved"
- callback: ((e: { isInside: boolean } & Point2D) => void)
  - - (e: { isInside: boolean } & Point2D): void
    - Parameters
      
      e: { isInside: boolean } & Point2D
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/view/view.ts:1205
prependOnceListener(eventName: "touchCancelled", callback: ((point: Point2D) => boolean)): void
Parameters
- eventName: "touchCancelled"
- callback: ((point: Point2D) => boolean)
  - - (point: Point2D): boolean
    - Parameters
      
      point: Point2D
      
      Returns boolean
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/view/view.ts:1206
prependOnceListener(eventName: TEvent, callback: ((...args: any[]) => void)): void
Parameters
- eventName: TEvent
- callback: ((...args: any[]) => void)
  - - (...args: any[]): void
    - Parameters
      
      Rest ...args: any[]
      
      Returns void
Returns void
Overrides NativeEventEmitterComponent.prependOnceListener
- Defined in ui/view/view.ts:1207

Constructors

constructor

new ViewBase<TEvent, TNative, TProps>(params?: Partial<TProps>): View<TEvent, TNative, TProps>
Type Parameters
- TEvent extends string = "touch" | "touchCancelled" | "touchEnded" | "touchMoved"
- TNative = any
- TProps extends IViewProps<MobileOSProps<ViewIOSProps, ViewAndroidProps>, TProps> = IViewProps<MobileOSProps<ViewIOSProps, ViewAndroidProps>>
Parameters
- Optional params: Partial<TProps>
Returns View<TEvent, TNative, TProps>
Overrides NativeEventEmitterComponent<TEvent | ViewEvents, TNative, TProps>.constructor
- Defined in ui/view/view.ts:1143

Class View<TEvent, TNative, TProps>

Type Parameters

TEvent extends string = ViewEvents

TNative = any

TProps extends IViewProps = IViewProps

Hierarchy

Index

Properties

Accessors

Methods

Constructors

Properties

Protected _nativeObject

Static iOS

Since

Type declaration

SemanticContentAttribute: typeof SemanticContentAttribute

Static Events

Type declaration

Touch: "touch"

TouchCancelled: "touchCancelled"

TouchEnded: "touchEnded"

TouchMoved: "touchMoved"

Static Border

Accessors

nativeObject

Returns any

Parameters

value: any

Returns void

ios

Returns TProps["ios"]

android

Returns TProps["android"]

Methods

Protected preConstruct

Parameters

Optional params: Partial<Record<string, any>>

Returns void

Protected addAndroidProps

Parameters

props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["android"]

Returns void

Protected addIOSProps

Parameters

props: WithMobileOSProps<TProps, { [key: string]: any }, { [key: string]: any }>["ios"]

Returns void

Protected createNativeObject

Returns any

on

Parameters

eventName: "touch"

callback: ((e: Point2D) => void)

Parameters

e: Point2D

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "touchEnded"

callback: ((e: { isInside: boolean } & Point2D) => void)

Parameters

e: { isInside: boolean } & Point2D

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "touchMoved"

callback: ((e: { isInside: boolean } & Point2D) => void)

Parameters

e: { isInside: boolean } & Point2D

Returns void

Returns (() => void)

Returns void

Parameters

eventName: "touchCancelled"

callback: ((point: Point2D) => boolean)

Parameters

point: Point2D

Returns boolean

`Protected` _nativeObject

`Static` iOS

`Static` Events

`Static` Border

`Protected` preConstruct

`Optional` params: Partial<Record<string, any>>

`Protected` addAndroidProps

`Protected` addIOSProps

`Protected` createNativeObject

`Rest` ...args: any[]

`Rest` ...args: any[]

`Rest` ...args: any[]