Skip to content

Commit b589fc8

Browse files
Merge branch 'dev' into feature/accessibility-colorshift
2 parents e510a50 + fd6b0ba commit b589fc8

35 files changed

+2155
-4871
lines changed

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## v5.0.0
4+
5+
*22 aug 2022*
6+
7+
- Moved Metrological and Platform specific plugins to [metrological-sdk](https://github.com/Metrological/metrological-sdk) (Metedata, Metrics, Pin, Profile, Purchase, TV, VideoPlayer)
8+
- Added base 64 image support for Image plugin
9+
- Fixed bug in Image plugin as Img cover stretches image
10+
- Fixed named route property not being accessed properly
11+
- Added/Updated Router available methods
12+
13+
314
## v4.8.3
415

516
*19 apr 2022*

docs/_sidebar.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
- [Log](/plugins/log.md)
99
- [Metadata](/plugins/metadata.md)
1010
- [Metrics](/plugins/metrics.md)
11-
- [Metadata](/plugins/metadata.md)
1211
- [Profile](/plugins/profile.md)
1312
- [Purchase](/plugins/purchase.md)
1413
- [Language](/plugins/language.md)

docs/changelog.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Changelog
22

3+
## v5.0.0
4+
5+
*22 aug 2022*
6+
7+
- Moved Metrological and Platform specific plugins to [metrological-sdk](https://github.com/Metrological/metrological-sdk) (Metedata, Metrics, Pin, Profile, Purchase, TV, VideoPlayer)
8+
- Added base 64 image support for Image plugin
9+
- Fixed bug in Image plugin as Img cover stretches image
10+
- Fixed named route property not being accessed properly
11+
- Added/Updated Router available methods
12+
13+
314
## v4.8.3
415

516
*19 apr 2022*

docs/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,33 @@ The Reference Documentation for Lightning SDK contains detailed descriptions of
66

77
The available Lightning SDK plugins are, in alphabetical order:
88

9+
<!---TOC_start--->
10+
* [Colors](plugins/colors.md)
911
* [FPS Counter](plugins/fpscounter.md)
1012
* [Image](plugins/image.md)
1113
* [Language](plugins/language.md)
1214
* [Lightning](plugins/lightning.md)
1315
* [Log](plugins/log.md)
16+
* [Metadata](plugins/metadata.md)
1417
* [Metrics](plugins/metrics.md)
1518
* [Pin](plugins/pin.md)
1619
* [Profile](plugins/profile.md)
1720
* [Purchase](plugins/purchase.md)
1821
* [Registry](plugins/registry.md)
1922
* [Router](plugins/router/index.md)
23+
* [Configuration](plugins/router/configuration.md)
24+
* [Navigation](plugins/router/navigation.md)
25+
* [Data Providing](plugins/router/dataproviding.md)
26+
* [Router Events](plugins/router/events.md)
27+
* [Page Transitions](plugins/router/pagetransitions.md)
28+
* [Widgets](plugins/router/widgets.md)
29+
* [Settings](plugins/router/settings.md)
30+
* [Deeplinking](plugins/router/deeplinking.md)
31+
* [History](plugins/router/history.md)
2032
* [Settings](plugins/settings.md)
2133
* [Storage](plugins/storage.md)
2234
* [TV](plugins/tv.md)
2335
* [Utils](plugins/utils.md)
2436
* [VersionLabel](plugins/versionlabel.md)
2537
* [VideoPlayer](plugins/videoplayer.md)
38+
<!---TOC_end--->

docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@lightningjs/sdk",
3-
"version": "4.8.3",
3+
"version": "5.0.0",
44
"license": "Apache-2.0",
55
"scripts": {
66
"postinstall": "node ./scripts/postinstall.js",
@@ -23,6 +23,7 @@
2323
"dependencies": {
2424
"@babel/polyfill": "^7.11.5",
2525
"@lightningjs/core": "*",
26+
"@metrological/sdk": "github:metrological/metrological-sdk",
2627
"@michieljs/execute-as-promise": "^1.0.0",
2728
"deepmerge": "^4.2.2",
2829
"localCookie": "github:WebPlatformForEmbedded/localCookie",

docs/plugins/colors/index.md

Lines changed: 0 additions & 131 deletions
This file was deleted.

docs/plugins/metadata.md

Lines changed: 1 addition & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -4,74 +4,4 @@ If you create an App, you store the App's *metadata* (such as its name, version
44

55
The Metadata plugin enables you to use this metadata in your App. (For example, if you want to show the App's version number in an *About* window.)
66

7-
> If you deploy your App to the Metrological Store, the metadata is 'injected' into the App by the Metrological Store.
8-
9-
## Usage
10-
11-
If you want to access metadata in your App code directly, import the *Metadata* plugin from the Lightning SDK:
12-
13-
```js
14-
import { Metadata } from '@lightningjs/sdk'
15-
```
16-
17-
The SDK automatically creates the `appMetadata` from the Launch params.
18-
19-
## Available methods
20-
21-
### Get
22-
23-
Returns the key value of the metadata.
24-
25-
```js
26-
Metadata.get(key, [fallback])
27-
```
28-
Key can be either `icon`, `id`, `safeId`, `version`, `name`, `description`, `type`, `url` or `artwork` .
29-
Optionally you can specify a `fallback`-value for when the Metadata is not defined.
30-
31-
### AppId
32-
33-
Gets Application id from Metadata
34-
35-
```js
36-
Metadata.appId()
37-
```
38-
39-
### SafeAppId
40-
41-
Returns the *safe ID* of your App. This is actually the `AppId` without dots (and any other special characters) which are are not permitted in JS variables.
42-
43-
```js
44-
Metadata.safeAppId()
45-
```
46-
47-
### AppName
48-
49-
Returns the name of your App.
50-
51-
```js
52-
Metadata.appName()
53-
```
54-
55-
### AppVersion
56-
57-
Returns the version of your App (without the GIT commit hash).
58-
59-
```js
60-
Metadata.appVersion()
61-
```
62-
63-
### AppIcon
64-
65-
Returns the icon of your App.
66-
67-
```js
68-
Metadata.appIcon()
69-
```
70-
71-
### AppFullVersion
72-
73-
Returns the full version of your App.
74-
75-
```js
76-
Metadata.appFullVersion()
77-
```
7+
> Starting <i>v5.0.0</i> and up, the Metadata plugin is part of the <b>metrological-sdk</b>.<br /><br />For backwards compatibility reasons, the Lightning-SDK exports this plugin provided by the metrological-sdk. The code however is maintained <a href="https://github.com/Metrological/metrological-sdk" target="_blank">here</a>. More information on how to use this plugin can be found <a href="https://github.com/Metrological/metrological-sdk/blob/master/docs/plugins/metadata.md" target="_blank">here</a>.

0 commit comments

Comments
 (0)