webos/signLang

Provide utility functions and higher order component for sign language.

Import Usage

import signLang from '@enact/webos/signLang';

Members

SignLangDecorator   Higher-Order Component

Usage:

import Button from '@enact/sandstone/Button';
import {SignLangDecorator} from '@enact/webos/signLang';
import {Component} from 'react';

const SignLangButton = SignLangDecorator(Button);

class Sample extends Component {
  render () {
    return(
      <div>
        <SignLangButton signLangId="settings_audioguide_1">Hello</SignLangButton>
      </div>
    );
  }
}

SignLangDecorator is a higher order component that adds feature for sign language to its wrapped component.

Import Usage

import {SignLangDecorator} from '@enact/webos/signLang';

Configuration

signLangDelay

Number

Time to wait (in milliseconds) before calling Sign Language API.

Default: 0

Properties added to wrapped component

signLangId

String

Unique ID for sign language.

---

signLangOption

Object

Additional option for sign language.

startSignLang   Function

startSignLang( signLangId, option ) → undefined

Activates sign language based on the singLangID.

2 Params

signLangId String

 default: ''

signLangId Unique ID used for sign language.

option Object

 default: {}

Additional option for sign language.

Returns

 undefined

stopSignLang   Function

stopSignLang( signLangId, option ) → undefined

Deactivates sign language based on the signLangID.

2 Params

signLangId String

 default: ''

signLangId Unique ID used for sign language.

option Object

 default: {}

Additional option for sign language.

Returns

 undefined