Interface WebViewAndroidProps

Hierarchy

Properties

yogaNode useForeground rippleEnabled rippleColor elevation zIndex borderTopLeftRadius borderTopRightRadius borderTopStartRadius borderTopEndRadius borderBottomLeftRadius borderBottomRightRadius borderBottomStartRadius borderBottomEndRadius updateRippleEffectIfNeeded overScrollMode page displayZoomControls

Events

onBackButtonPressed? onConsoleMessage?

Methods

clearFormData clearHistory setWebContentsDebuggingEnabled

Properties

Readonly yogaNode

yogaNode: any

useForeground

useForeground: boolean

Gets/sets foreground of the view for ripple effect. This property should be set before rippleColor. This property only supported for api level 23 and above.

Property

= false]

Android

Member

UI.View

Since

4.0.2

rippleEnabled

rippleEnabled: boolean

Gets/sets ripple effect enabled for view. You should set UI.View#rippleColor rippleColor to see the effect.

Property

= false]

Android

Member

UI.View

Since

3.2.1

rippleColor

rippleColor: IColor

Gets/sets ripple effect color for view.

Property

Android

Member

UI.View

Since

3.2.1

elevation

elevation: number

Gets/Sets the elevation of the view. For the views that has StateListAnimator natively like Button, will lost its own StateListAnimation when elevation value changed. For details : https://developer.android.com/training/material/shadows-clipping.html

Property

Android

Member

UI.View

See

Since

1.1.12

zIndex

zIndex: number

Gets/sets the depth location of the view relative to its elevation. To put view over button, you have to change zIndex value after Android Lollipop. On android, default elevation value of button is bigger than other view. This property affects after Android Lollipop. No-op before api level 21.

Property

Android

Member

UI.View

Since

2.0.8

borderTopLeftRadius

borderTopLeftRadius: number

Sets/gets top-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopRightRadius

borderTopRightRadius: number

Sets/gets top-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderTopStartRadius

borderTopStartRadius: number

Sets/gets top-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderTopEndRadius

borderTopEndRadius: number

Sets/gets top-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomLeftRadius

borderBottomLeftRadius: number

Sets/gets bottom-left corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomRightRadius

borderBottomRightRadius: number

Sets/gets bottom-right corner radius of a view.

Property

= 0]

Android

Since

5.1.1

borderBottomStartRadius

borderBottomStartRadius: number

Sets/gets bottom-start corner radius of a view.

Property

= -1]

Android

Since

5.1.1

borderBottomEndRadius

borderBottomEndRadius: number

Sets/gets bottom-end corner radius of a view.

Property

= -1]

Android

Since

5.1.1

updateRippleEffectIfNeeded

updateRippleEffectIfNeeded: (() => void)

Type declaration

    • (): void

    • Returns void

overScrollMode

overScrollMode: OverScrollMode

Gets/sets over-scroll mode for this view.

Property

= UI.Android.OverScrollMode.ALWAYS]

Android

Since

3.2.1

page

page: PageImpl

Sets/Gets the current page which contains the webview.

Property

Android

Since

2.0.10

displayZoomControls

displayZoomControls: boolean

Sets/Gets the visibility of zoom controls.

Property

Android

Since

4.3.4

Events

Optional onBackButtonPressed

onBackButtonPressed?: (() => void)

Type declaration

    • (): void

    • This event will be triggered when user clicks back button on the Device. WebView is focusable view. When it gains focus, this event begin to trigger. The purpose of using this event might be navigating back to pervious web pages.

      onBackButtonPressed

      Deprecated

      Android

      Since

      3.2.1

      Example

      import WebView from '@smartface/native/ui/webview';

      const webView = new WebView();
      webView.on(WebView.Events.BackButtonPressed, () => {
          console.info('onBackButtonPressed');
      });

      Returns void

Optional onConsoleMessage

onConsoleMessage?: ((params: { sourceId: number; message: string; lineNumber: number; messageLevel: string }) => boolean)

Type declaration

    • (params: { sourceId: number; message: string; lineNumber: number; messageLevel: string }): boolean

    • Report a JavaScript console message to the host application.

      onConsoleMessage

      Deprecated

      Android

      Since

      4.0.4

      Example

      import WebView from '@smartface/native/ui/webview';

      const webView = new WebView();
      webView.on(WebView.Events.ConsoleMessage, (params) => {
          console.info('onConsoleMessage', params);
      });

      Parameters

      • params: { sourceId: number; message: string; lineNumber: number; messageLevel: string }
        • sourceId: number

          The name of the source file that caused the error.

        • message: string

          The error message to report.

        • lineNumber: number

          The line number of the error.

        • messageLevel: string

          The message level of the report

      Returns boolean

Methods

clearFormData

  • Removes the autocomplete popup from the currently focused form field, if present.

    Method

    clearFormData

    Android

    Since

    2.0.7

    Returns void

clearHistory

  • Tells this WebView to clear its internal back and forward list.

    Method

    clearHistory

    Android

    Since

    2.0.7

    Returns void

setWebContentsDebuggingEnabled

  • Enables debugging of WebView contents.

    Method

    setWebContentsDebuggingEnabled

    Android

    Static

    Since

    4.0.6

    Parameters

    • Optional enabled: boolean

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc