@enact/i18n

@enact/i18n

Enact library for internationalization

@enact/i18n provides a decorator that can be used to wrap a root component in a React (or Enact) application. This decorator provides a context to child components that can be used to determine locale text directionality and to update the current locale. Additionally, it provides a locale-aware Uppercase Higher Order Component (HOC).

Usage

import {I18nDecorator, contextTypes} from `@enact/i18n/I18nDecorator`;

const MyComponent = (props, context) => (
    <div>{context.rtl ? "right to left" : "left to right"}</div>
);

// Without contextTypes, your component will not receive context!
MyComponent.contextTypes = contextTypes;

const MyApp = () => (
    <div>
        <MyComponent />
    </div>
);

const MyI18nApp = I18nDecorator(MyApp);

Uppercase may be used independently of the app decorator. By default, it uppercases the children property of the wrapped component, provided it is a string.

import Uppercase from `@enact/i18n/Uppercase`

const MyComponent = (props) => (
    <div {...props} />
);

const MyUppercaseComponent = Uppercase(MyComponent);

Passing preserveCase in the props to MyUppercaseComponent will prevent uppercasing.

Install

npm install --save @enact/i18n

Acknowledgments

This module is built upon the iLib library.

Copyright and License Information

Unless otherwise specified, all content, including all source code files and documentation files in this repository are:

Copyright (c) 2016-2017 LG Electronics

Unless otherwise specified or set forth in the NOTICE file, all content, including all source code files and documentation files in this repository are: Licensed under the Apache License, Version 2.0 (the "License"); you may not use this content except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

This work is based on the Apache-2.0 licensed iLib from JEDLsoft.

Changelog

[1.0.0-beta.2] - 2017-01-30

Added

• Support for a new handlers block for components created with core/kind to allow cached event handlers
• core/handle handler forKey
• core/keymap module to abstract keyboard key codes behind common names (e.g. 'up' and 'down')
• moonstone/Panels.Panel property showChildren to support deferring rendering the panel body until animation completes
• moonstone/MarqueeDecorator property invalidateProps that specifies which props cause the marquee distance to be invalidated
• developer-mode warnings to several components to warn when values are out-of-range
• moonstone/Divider property spacing which adjusts the amount of empty space above and below the Divider. 'normal', 'small', 'medium', 'large', and 'none' are available.
• moonstone/Picker when joined the ability to be incremented and decremented by arrow keys
• onSpotlightDisappear event property support for spottable moonstone components
• spotlight.SpotlightContainerDecorator support for spotlightDisabled prop
• spotlight.Spottable support for onSpotlightDown, onSpotlightLeft, onSpotlightRight, and onSpotlightUp properties
• spotlight.Spotlight method getDirection to replace spotlightDirections
• ui/ViewManager properties enteringDelay and enteringProp to aid deferred rendering of views
• ui/resolution function scaleToRem for those times when you have a size in pixels that you want to convert directly to rem to support automatic dynamic resizing

Changed

• moonstone/Panels.Panels and variations to defer rendering the children of contained Panel instances until animation completes
• moonstone/ProgressBar properties progress and backgroundProgress to accept a number between 0 and 1
• moonstone/Slider and moonstone/IncrementSlider property backgroundPercent to backgroundProgress which now accepts a number between 0 and 1
• moonstone/Slider to not ignore value prop when it is the same as the previous value
• moonstone/Picker component's buttons to reverse their operation such that 'up' selects the previous item and 'down' the next
• moonstone/Picker and derivatives may now use numeric width, which represents the amount of characters to use for sizing. width={4} represents four characters, 2 for two characters, etc. width still accepts the size-name strings.
• moonstone/Divider to now behave as a simple horizontal line when no text content is provided
• moonstone/Scrollable to not display scrollbar controls by default
• moonstone/DatePicker and moonstone/TimePicker to emit onChange event whenever the value is changed, not just when the component is closed

Removed

• core/handle.withArgs helper function which is no longer needed with the addition of the handlers support in kind()
• moonstone/ProgressBar properties min and max
• spotlight spotlightDirections

Fixed

• moonstone/IncrementSlider so that the knob is spottable via pointer, and 5-way navigation between the knob and the increment/decrement buttons is functional
• moonstone/Slider and moonstone/IncrementSlider to not fire onChange for value changes from props