lion/packages/localize/README.md
2020-05-29 17:01:15 +02:00

44 lines
1.5 KiB
Markdown

[//]: # 'AUTO INSERT HEADER PREPUBLISH'
# Localize
```js script
export default {
title: 'Localize/Intro',
};
```
Is meant to translate text into multiple languages.
In it's simplest form it is a function that returns the translated text for a namespace + key.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/localize--page) for a live demo and documentation
## Features
- Uses es modules
- Formatting of numbers, amounts
- Formatting of dates
Further examples can be seen at [Features Overview Demo](?path=/docs/localize-features-overview--as-function) and a more in depth description can be found at [Localize System Overview](?path=/docs/localize-system-overview--page).
## Content
| Feature | Description |
| --------------------------------------------------------------------- | --------------------------------------------- |
| [Translate Text](?path=/docs/localize-features-overview--as-function) | Load and translate text in multiple languages |
| [Format Numbers](?path=/docs/localize-numbers--formatting) | Format numbers in multiple languages |
| [Format Dates](?path=/docs/localize-dates--formatting) | Format dates in multiple languages |
## How to use
### Installation
```bash
npm i --save @lion/localize
```
```js
import { localize } from '@lion/localize';
```