@lightningjs/blits 1.30.1 → 1.30.2

package/docs/plugins/language.md

@@ -1,172 +1,172 @@
-# Language plugin
-
-Blits comes with a built-in Language plugin, that can be used to add internationalization (i18n) to your App.
-
-The Blits Language plugin is a simple and lightweight implementation, closely modeled after the tried and tested Language plugin in the Lightning-SDK (for Lightning 2). It is designed to provide a flexible and easy way of translating texts to multiple languages, in a performant way.
-
-## Registering the plugin
-
-While the Language plugin is provided in the core Blits package, it's an _optional_ plugin that needs to be registered before you're able to use it. As such the Language plugin is _tree-shakable_, i.e. for Apps that don't have a need for translation functionality, the Language plugin will not be part of the final App bundle.
-
-The Language plugin should be imported from Blits and registered in the App's `index.js`, as demonstrated in the example below.
-
-Make sure to place the `Blits.Plugin()` method _before_ calling the `Blits.Launch()` method
-
-```js
-// index.js
-
-import Blits from '@lightningjs/blits'
-// import the language plugin
-import { language } from '@lightningjs/blits/plugins'
-
-import App from './App.js'
-
-// Use the Blits Language plugin and
-// optionally pass in a settings object
-Blits.Plugin(language, {
-  file: '/assets/translations.json', // file with translations
-  language: 'EN-us', // default language
-})
-
-
-Blits.Launch(App, 'app', {
-  // launch settings
-})
-```
-
-The Language plugin accepts an optional configuration object with 2 keys:
-
-- `file` - the JSON file with translations to be loaded at initialization
-- `language` - the default language to use
-
-After registration of the Language plugin, it will be available in each Blits Component as `this.$language`.
-
-## Translations file
-
-The most common way of defining a set of translations, is to use a dedicated JSON file, modeled after
-the following format:
-
-```json
-{
-    "nl-NL": {
-      "hello": "Hallo, alles goed?",
-      "bye": "Doei!",
-      "replacement": "Mijn naam is {first} {last}, ik ben {age} jaar"
-    },
-    "en-US": {
-      "hello": "Hello, how are you doing?",
-      "bye": "Goodbye!",
-      "replacement": "My name is {first} {last}, I'm {age} years old"
-    },
-    "fr-FR": {
-      "hello": "Bonjour, ça va?",
-      "bye": "Au revoir!",
-      "replacement": "Je m'appelle {first} {last}, j'ai {age} ans"
-    },
-    "de-DE": {
-      "hello": "Gutentag, wie geht's?",
-      "bye": "Tschüss!",
-      "replacement": "Mein Name ist {first} {last}, ich bin {age} Jahre alt"
-    }
-  }
-```
-
-Each top level key represents a language, which contains an object with translation key-value pairs. The language key
-doesn't require to be in a specific format, but it's recommended to use ISO-codes.
-
-When the JSON file is specified in the Plugin registration method, the language file is loaded automatically upon instantiation.
-
-In case you want to load the file with translations manually, you can use the `this.$language.load()`-method anywhere in a Component and pass in the path to the JSON file as the first argument.
-
-## Defining translations manually
-
-As an alternative to a JSON file with translations, you can also define translations directly via an object, using the `translations()`-method.
-
-The `this.$language.translations()`-methods accepts a translations object as it's first argument, following the same format as the JSON file. The method is typically used in an `init` or `ready` hook
-
-```js
-Blits.Component('MyComponent', {
-  // ...
-  hooks: {
-    init() {
-      this.$language.translations({
-        english: {
-          hello: "Hello",
-          world: "World"
-        },
-        italian: {
-          hello: "Ciao",
-          world: "Mondo"
-        }
-      })
-    }
-  },
-})
-```
-
-## Setting the language
-
-In order to set (or change) the current language, the `this.$language.set()`-method can be used, passing in the new language code (matching one of the languages defined in the translations).
-
-```js
-Blits.Component('MyComponent', {
-  // ...
-  input: {
-    enter() {
-      this.$language.set('pt-BR')
-    }
-  },
-})
-```
-
-## Getting the current language
-
-The current language can be retrieved via the `this.$language.language` property. It will return the currently set language code.
-
-## Translating
-
-The most important functionality in the Language plugin is translating. The Language plugin exposes a `translate()` method that takes as string to translate as it's first argument. It will return the translated value in the currently set language. If either the language or the string to translate can't be found, it will return the inputed string.
-
-The translate method can be used both inside the javascript business logic, but also directly in the template.
-
-```js
-Blits.Component('MyComponent', {
-  template: `
-    <Element>
-      <Text :content="$$language.translate('hello')" />
-      <Text y="100" :content="$$language.get()" />
-    </Element>
-  `,
-  hooks: {
-    ready() {
-      console.log(this.$language.translate('world'))
-    }
-  },
-})
-```
-
-Note that in the template definition 2 consecutive dollars signs are used (`$$language`). The first `$`-sign is used
-to refer to the Component scope, as with any other state variable or computed property refereced in the template.
-
-The second `$`-sign is needed, since the Language plugin itself is prefixed with a dollar sign on the Component scope as well (i.e `this.$language`).
-
-
-### Dynamic replacements
-
-The `tranlate()`-method also supports dynamic replacements. This allows you to specify variables inside your translation string, and replace them with dynamic values passed into the `translate()`-method.
-
-Replacements are marked in the translation value using _handlebars_, like so:
-
-```js
-{
-  replacements = "My name is {first} {last}, I'm {age} years old"
-}
-```
-
-Now when you call the `translate()`-method and pass in an object with dynamic values, those will be replaced
-in the final string accordingly:
-
-```js
-this.$language.translate('replacements', {name: 'John', last: 'Doe', age: 18})
-// result: My name is John Doe, I'm 18 years old
-```
+# Language plugin
+
+Blits comes with a built-in Language plugin, that can be used to add internationalization (i18n) to your App.
+
+The Blits Language plugin is a simple and lightweight implementation, closely modeled after the tried and tested Language plugin in the Lightning-SDK (for Lightning 2). It is designed to provide a flexible and easy way of translating texts to multiple languages, in a performant way.
+
+## Registering the plugin
+
+While the Language plugin is provided in the core Blits package, it's an _optional_ plugin that needs to be registered before you're able to use it. As such the Language plugin is _tree-shakable_, i.e. for Apps that don't have a need for translation functionality, the Language plugin will not be part of the final App bundle.
+
+The Language plugin should be imported from Blits and registered in the App's `index.js`, as demonstrated in the example below.
+
+Make sure to place the `Blits.Plugin()` method _before_ calling the `Blits.Launch()` method
+
+```js
+// index.js
+
+import Blits from '@lightningjs/blits'
+// import the language plugin
+import { language } from '@lightningjs/blits/plugins'
+
+import App from './App.js'
+
+// Use the Blits Language plugin and
+// optionally pass in a settings object
+Blits.Plugin(language, {
+  file: '/assets/translations.json', // file with translations
+  language: 'EN-us', // default language
+})
+
+
+Blits.Launch(App, 'app', {
+  // launch settings
+})
+```
+
+The Language plugin accepts an optional configuration object with 2 keys:
+
+- `file` - the JSON file with translations to be loaded at initialization
+- `language` - the default language to use
+
+After registration of the Language plugin, it will be available in each Blits Component as `this.$language`.
+
+## Translations file
+
+The most common way of defining a set of translations, is to use a dedicated JSON file, modeled after
+the following format:
+
+```json
+{
+    "nl-NL": {
+      "hello": "Hallo, alles goed?",
+      "bye": "Doei!",
+      "replacement": "Mijn naam is {first} {last}, ik ben {age} jaar"
+    },
+    "en-US": {
+      "hello": "Hello, how are you doing?",
+      "bye": "Goodbye!",
+      "replacement": "My name is {first} {last}, I'm {age} years old"
+    },
+    "fr-FR": {
+      "hello": "Bonjour, ça va?",
+      "bye": "Au revoir!",
+      "replacement": "Je m'appelle {first} {last}, j'ai {age} ans"
+    },
+    "de-DE": {
+      "hello": "Gutentag, wie geht's?",
+      "bye": "Tschüss!",
+      "replacement": "Mein Name ist {first} {last}, ich bin {age} Jahre alt"
+    }
+  }
+```
+
+Each top level key represents a language, which contains an object with translation key-value pairs. The language key
+doesn't require to be in a specific format, but it's recommended to use ISO-codes.
+
+When the JSON file is specified in the Plugin registration method, the language file is loaded automatically upon instantiation.
+
+In case you want to load the file with translations manually, you can use the `this.$language.load()`-method anywhere in a Component and pass in the path to the JSON file as the first argument.
+
+## Defining translations manually
+
+As an alternative to a JSON file with translations, you can also define translations directly via an object, using the `translations()`-method.
+
+The `this.$language.translations()`-methods accepts a translations object as it's first argument, following the same format as the JSON file. The method is typically used in an `init` or `ready` hook
+
+```js
+Blits.Component('MyComponent', {
+  // ...
+  hooks: {
+    init() {
+      this.$language.translations({
+        english: {
+          hello: "Hello",
+          world: "World"
+        },
+        italian: {
+          hello: "Ciao",
+          world: "Mondo"
+        }
+      })
+    }
+  },
+})
+```
+
+## Setting the language
+
+In order to set (or change) the current language, the `this.$language.set()`-method can be used, passing in the new language code (matching one of the languages defined in the translations).
+
+```js
+Blits.Component('MyComponent', {
+  // ...
+  input: {
+    enter() {
+      this.$language.set('pt-BR')
+    }
+  },
+})
+```
+
+## Getting the current language
+
+The current language can be retrieved via the `this.$language.language` property. It will return the currently set language code.
+
+## Translating
+
+The most important functionality in the Language plugin is translating. The Language plugin exposes a `translate()` method that takes as string to translate as it's first argument. It will return the translated value in the currently set language. If either the language or the string to translate can't be found, it will return the inputed string.
+
+The translate method can be used both inside the javascript business logic, but also directly in the template.
+
+```js
+Blits.Component('MyComponent', {
+  template: `
+    <Element>
+      <Text :content="$$language.translate('hello')" />
+      <Text y="100" :content="$$language.get()" />
+    </Element>
+  `,
+  hooks: {
+    ready() {
+      console.log(this.$language.translate('world'))
+    }
+  },
+})
+```
+
+Note that in the template definition 2 consecutive dollars signs are used (`$$language`). The first `$`-sign is used
+to refer to the Component scope, as with any other state variable or computed property refereced in the template.
+
+The second `$`-sign is needed, since the Language plugin itself is prefixed with a dollar sign on the Component scope as well (i.e `this.$language`).
+
+
+### Dynamic replacements
+
+The `tranlate()`-method also supports dynamic replacements. This allows you to specify variables inside your translation string, and replace them with dynamic values passed into the `translate()`-method.
+
+Replacements are marked in the translation value using _handlebars_, like so:
+
+```js
+{
+  replacements = "My name is {first} {last}, I'm {age} years old"
+}
+```
+
+Now when you call the `translate()`-method and pass in an object with dynamic values, those will be replaced
+in the final string accordingly:
+
+```js
+this.$language.translate('replacements', {name: 'John', last: 'Doe', age: 18})
+// result: My name is John Doe, I'm 18 years old
+```

package/docs/plugins/text-to-speech-announcer.md

@@ -1,120 +1,120 @@
-# Text-to-Speech / Announcer
-
-Blits comes with a built-in Text-to-Speech / Announcer functionality, to easily make your App more accessible. This is something that's often overlooked when developing an App, but having speech assistance integrated into your App is a huge deal for those users who are visually impaired.
-
-## Integrated with the router
-
-The Announcer in Blits is directly integrated with the router functionality. This means that through simple configuration, a descriptive message can be announced, when navigating from page to page, without the need for adding extra custom code.
-
-Just add an `announce` key in the configuration of your route, that contains the message you would like to be announced when visiting that route.
-
-```js
-const routes = [
-  // ...
-  {
-    path: '/settings',
-    component: Settings,
-    announce: "Welcome to the Settings page",
-  },
-  // ...
-]
-```
-
-## Custom announcement messages
-
-Furthermore, it's possible to speak out custom messages anywhere in your App logic, for example when a component receives focus, as a reaction to user input, or to announce error messages when a remote API call
-fails.
-
-Each component in Blits has a `this.$announcer.speak()` available, which accepts a `string` with the message to be announced.
-
-```js
-Blits.Component('MyComponent', {
-  // ...
-  hooks: {
-    focus() {
-      this.$announcer.speak('MyComponent just got focus')
-    }
-  },
-  keys: {
-    right() {
-      if(this.focused === this.items.length - 1) {
-        this.$announcer.speak('End of row reached')
-      } else {
-        //
-      }
-    }
-  }
-})
-```
-
-### Execute logic when done
-
-The `speak()`-function returns a promise that resolves when it's done speaking, or when it's interupted or errors out. The reason of the `speak()` method resolving is passed as an argument into the resolve function.
-
-```js
-this.$announcer.speak('Hello').then((reason) => console.log('Speaking hello finished', reason))
-```
-
-### Announcement queue
-
-The `speak()`-method places the messages in an announcement queue and then starts processing that queue. That means that when the queue is empty, it will instantly announce the messages passed. If there are other messages in the queue, the messages will be spoken when all previous messages are announced.
-
-Optionally you can set the politeness of a message to `assertive` and pass it a the second argument of the `speak()`-method.
-
-```js
-this.$announcer.speak('Very important message that should get priority', 'assertive')
-```
-
-This will place the message at the beginning of the queue, making in the first message to be announced after the current message (if any) has finished.
-
-#### Clearing and interupting
-
-Since each message added into the queue may take a bit of time to actually be announced, it's possible that the user has navigated elsewhere in the mean time, making the queued up messages not relevant.
-
-The announcer plugin allows you to clear the entire queue by calling `this.$announcer.clear()`. Additionally if you want to interup the messages being currently spoken, the announcer plugin offers the `this.$announcer.stop()`-method.
-
-#### Canceling individual messages
-
-In some cases you may not want to clear the entire queue, but instead cancel out a single message.
-
-Imagine an App with a row of tiles, it's possible that before the title of the role is being spoken out, the user already navigates through the tiles within the row. Traditionally you'd use the focus event to speak out info about each tile (i.e. adding tot the queue). You don't want all previously focused tiles to still be announced, but would still want the category of the row to be announced, making clearing the queue not required.
-
-The `speak()`-method return a Promise that also contains a `cancel()` function. When called, it will cancel that specific message and remove it from the queue before it can be spoken out.
-
-Additionally if you want to _interrupt_ a specific messages as it's being spoken out as well and go straight to the next message in the queue (i.e. the newly focused item, for example). You can use the `stop()` message that is returned on the Promise returned by the `speak()`-method.
-
-```js
-Blits.Component('MyTile', {
-  //
-  props: ['title'],
-  state() {
-    return {
-      message: null
-    }
-  },
-  hooks: {
-    focus() {
-      // add message to the announcement queue
-      this.message = this.$announcer.speak(`This is tile ${this.title}`)
-    },
-    unfocus() {
-      // when unfocused interrupt the message if it's already being spoken out
-      this.message.stop()
-      // and cancel the message to remove it from the queue
-      this.message.cancel()
-    }
-  }
-})
-```
-
-## Enabling / disabling the announcer
-
-By default the announcer is disabled. This means that whenever you call `this.$announcer.speak()` there will actually not be anything spoken out via the Text To Speech engine.
-
-In order to enable utterances being spoken out, you can set the Blits launch setting `announcer` to `true` in the index.js.
-
-Alternatively the announcer can be enabled or disabled run time by using one of the following methods on the Announcer pluging:
-
-- `this.$announcer.enable()` - activates the announcer
-- `this.$announcer.disable()` - deactivates the announcer
+# Text-to-Speech / Announcer
+
+Blits comes with a built-in Text-to-Speech / Announcer functionality, to easily make your App more accessible. This is something that's often overlooked when developing an App, but having speech assistance integrated into your App is a huge deal for those users who are visually impaired.
+
+## Integrated with the router
+
+The Announcer in Blits is directly integrated with the router functionality. This means that through simple configuration, a descriptive message can be announced, when navigating from page to page, without the need for adding extra custom code.
+
+Just add an `announce` key in the configuration of your route, that contains the message you would like to be announced when visiting that route.
+
+```js
+const routes = [
+  // ...
+  {
+    path: '/settings',
+    component: Settings,
+    announce: "Welcome to the Settings page",
+  },
+  // ...
+]
+```
+
+## Custom announcement messages
+
+Furthermore, it's possible to speak out custom messages anywhere in your App logic, for example when a component receives focus, as a reaction to user input, or to announce error messages when a remote API call
+fails.
+
+Each component in Blits has a `this.$announcer.speak()` available, which accepts a `string` with the message to be announced.
+
+```js
+Blits.Component('MyComponent', {
+  // ...
+  hooks: {
+    focus() {
+      this.$announcer.speak('MyComponent just got focus')
+    }
+  },
+  keys: {
+    right() {
+      if(this.focused === this.items.length - 1) {
+        this.$announcer.speak('End of row reached')
+      } else {
+        //
+      }
+    }
+  }
+})
+```
+
+### Execute logic when done
+
+The `speak()`-function returns a promise that resolves when it's done speaking, or when it's interupted or errors out. The reason of the `speak()` method resolving is passed as an argument into the resolve function.
+
+```js
+this.$announcer.speak('Hello').then((reason) => console.log('Speaking hello finished', reason))
+```
+
+### Announcement queue
+
+The `speak()`-method places the messages in an announcement queue and then starts processing that queue. That means that when the queue is empty, it will instantly announce the messages passed. If there are other messages in the queue, the messages will be spoken when all previous messages are announced.
+
+Optionally you can set the politeness of a message to `assertive` and pass it a the second argument of the `speak()`-method.
+
+```js
+this.$announcer.speak('Very important message that should get priority', 'assertive')
+```
+
+This will place the message at the beginning of the queue, making in the first message to be announced after the current message (if any) has finished.
+
+#### Clearing and interupting
+
+Since each message added into the queue may take a bit of time to actually be announced, it's possible that the user has navigated elsewhere in the mean time, making the queued up messages not relevant.
+
+The announcer plugin allows you to clear the entire queue by calling `this.$announcer.clear()`. Additionally if you want to interup the messages being currently spoken, the announcer plugin offers the `this.$announcer.stop()`-method.
+
+#### Canceling individual messages
+
+In some cases you may not want to clear the entire queue, but instead cancel out a single message.
+
+Imagine an App with a row of tiles, it's possible that before the title of the role is being spoken out, the user already navigates through the tiles within the row. Traditionally you'd use the focus event to speak out info about each tile (i.e. adding tot the queue). You don't want all previously focused tiles to still be announced, but would still want the category of the row to be announced, making clearing the queue not required.
+
+The `speak()`-method return a Promise that also contains a `cancel()` function. When called, it will cancel that specific message and remove it from the queue before it can be spoken out.
+
+Additionally if you want to _interrupt_ a specific messages as it's being spoken out as well and go straight to the next message in the queue (i.e. the newly focused item, for example). You can use the `stop()` message that is returned on the Promise returned by the `speak()`-method.
+
+```js
+Blits.Component('MyTile', {
+  //
+  props: ['title'],
+  state() {
+    return {
+      message: null
+    }
+  },
+  hooks: {
+    focus() {
+      // add message to the announcement queue
+      this.message = this.$announcer.speak(`This is tile ${this.title}`)
+    },
+    unfocus() {
+      // when unfocused interrupt the message if it's already being spoken out
+      this.message.stop()
+      // and cancel the message to remove it from the queue
+      this.message.cancel()
+    }
+  }
+})
+```
+
+## Enabling / disabling the announcer
+
+By default the announcer is disabled. This means that whenever you call `this.$announcer.speak()` there will actually not be anything spoken out via the Text To Speech engine.
+
+In order to enable utterances being spoken out, you can set the Blits launch setting `announcer` to `true` in the index.js.
+
+Alternatively the announcer can be enabled or disabled run time by using one of the following methods on the Announcer pluging:
+
+- `this.$announcer.enable()` - activates the announcer
+- `this.$announcer.disable()` - deactivates the announcer
 - `this.$announcer.disable(true/false)` - turns the announcer or on off