@scaleflex/widget-informer 4.0.7 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7611 -7599
- package/LICENSE +21 -21
- package/README.md +85 -85
- package/lib/index.js +6 -6
- package/package.json +5 -5
- package/types/index.d.ts +12 -12
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2019 scaleflex
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2019 scaleflex
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,85 +1,85 @@
|
|
|
1
|
-
# `@scaleflex/widget-informer`
|
|
2
|
-
|
|
3
|
-
[![Plugins][plugins-image]](#plugins)
|
|
4
|
-
[![Website][filerobot-image]][sfx-url]
|
|
5
|
-
[![Version][filerobot-version]][version-url]
|
|
6
|
-
[![Scaleflex team][made-by-image]][sfx-url]
|
|
7
|
-
[![License][license-image]][license-url]
|
|
8
|
-
[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
<div align='center'>
|
|
12
|
-
<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
|
|
13
|
-
</div>
|
|
14
|
-
|
|
15
|
-
A pop-up alert for showing info, warnings or errors in [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) when other plugins needs to show some message with any of the mentioned types.
|
|
16
|
-
|
|
17
|
-
## Usage
|
|
18
|
-
|
|
19
|
-
### NPM
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npm install --save @scaleflex/widget-informer
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### YARN
|
|
26
|
-
|
|
27
|
-
```bash
|
|
28
|
-
yarn add @scaleflex/widget-informer
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
then
|
|
32
|
-
|
|
33
|
-
```js
|
|
34
|
-
import Informer from '@scaleflex/widget-informer'
|
|
35
|
-
...
|
|
36
|
-
...
|
|
37
|
-
...
|
|
38
|
-
scaleflexWidget.use(Informer, propertiesObject)
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### CDN
|
|
42
|
-
|
|
43
|
-
The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Informer`
|
|
44
|
-
|
|
45
|
-
```js
|
|
46
|
-
const Informer = window.ScaleflexWidget.Informer
|
|
47
|
-
...
|
|
48
|
-
...
|
|
49
|
-
...
|
|
50
|
-
scaleflexWidget.use(Informer, propertiesObject)
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
> If you are using [`@scaleflex/widget-explorer`](../@scaleflex/widget-explorer/#filerobotexplorer) plugin you don't need to manually import this plugin as it is being imported automatically there with its styles and the default id `Explorer:Informer` Unless the Explorer id is changed.
|
|
54
|
-
|
|
55
|
-
### Plugin's styles
|
|
56
|
-
|
|
57
|
-
```js
|
|
58
|
-
import '@scaleflex/widget-core/dist/style.css'
|
|
59
|
-
import '@scaleflex/widget-informer/dist/style.css'
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
or if you prefer the minified version
|
|
63
|
-
|
|
64
|
-
```js
|
|
65
|
-
import '@scaleflex/widget-core/dist/style.min.css'
|
|
66
|
-
import '@scaleflex/widget-informer/dist/style.min.css'
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
> The plugin's css file should be imported after the [Core's css file](../@scaleflex/widget-core/#modules-styles) for having the styles shown correctly.
|
|
70
|
-
|
|
71
|
-
<!-- Variables -->
|
|
72
|
-
|
|
73
|
-
[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-informer
|
|
74
|
-
[license-url]: https://opensource.org/licenses/MIT
|
|
75
|
-
[sfx-url]: https://www.scaleflex.com/
|
|
76
|
-
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-informer
|
|
77
|
-
[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
|
|
78
|
-
|
|
79
|
-
[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
|
|
80
|
-
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
|
|
81
|
-
[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
|
|
82
|
-
[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
|
|
83
|
-
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
|
|
84
|
-
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-informer?label=Version&style=for-the-badge&logo=npm
|
|
85
|
-
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
|
|
1
|
+
# `@scaleflex/widget-informer`
|
|
2
|
+
|
|
3
|
+
[![Plugins][plugins-image]](#plugins)
|
|
4
|
+
[![Website][filerobot-image]][sfx-url]
|
|
5
|
+
[![Version][filerobot-version]][version-url]
|
|
6
|
+
[![Scaleflex team][made-by-image]][sfx-url]
|
|
7
|
+
[![License][license-image]][license-url]
|
|
8
|
+
[![CodeSandbox][codeSandbox-image]][codeSandbox-url]
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
<div align='center'>
|
|
12
|
+
<img title="Scaleflex Widget logo" alt="Scaleflex Widget logo" src="https://assets.scaleflex.com/Corporate+Branding/%5B2025%5D+ALL+LOGOS+%2B+ICONS/SCALEFLEX/VXP+logo/Horizontal+White/VXP+logo+WHITE.png?vh=663932" width="140"/>
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
A pop-up alert for showing info, warnings or errors in [Scaleflex Media Asset Widget](https://www.npmjs.com/package/@scaleflex/widget-core) when other plugins needs to show some message with any of the mentioned types.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
### NPM
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install --save @scaleflex/widget-informer
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### YARN
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
yarn add @scaleflex/widget-informer
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
then
|
|
32
|
+
|
|
33
|
+
```js
|
|
34
|
+
import Informer from '@scaleflex/widget-informer'
|
|
35
|
+
...
|
|
36
|
+
...
|
|
37
|
+
...
|
|
38
|
+
scaleflexWidget.use(Informer, propertiesObject)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### CDN
|
|
42
|
+
|
|
43
|
+
The plugin from CDN is found inside `Scaleflex` global object `Scaleflex.Informer`
|
|
44
|
+
|
|
45
|
+
```js
|
|
46
|
+
const Informer = window.ScaleflexWidget.Informer
|
|
47
|
+
...
|
|
48
|
+
...
|
|
49
|
+
...
|
|
50
|
+
scaleflexWidget.use(Informer, propertiesObject)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> If you are using [`@scaleflex/widget-explorer`](../@scaleflex/widget-explorer/#filerobotexplorer) plugin you don't need to manually import this plugin as it is being imported automatically there with its styles and the default id `Explorer:Informer` Unless the Explorer id is changed.
|
|
54
|
+
|
|
55
|
+
### Plugin's styles
|
|
56
|
+
|
|
57
|
+
```js
|
|
58
|
+
import '@scaleflex/widget-core/dist/style.css'
|
|
59
|
+
import '@scaleflex/widget-informer/dist/style.css'
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
or if you prefer the minified version
|
|
63
|
+
|
|
64
|
+
```js
|
|
65
|
+
import '@scaleflex/widget-core/dist/style.min.css'
|
|
66
|
+
import '@scaleflex/widget-informer/dist/style.min.css'
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
> The plugin's css file should be imported after the [Core's css file](../@scaleflex/widget-core/#modules-styles) for having the styles shown correctly.
|
|
70
|
+
|
|
71
|
+
<!-- Variables -->
|
|
72
|
+
|
|
73
|
+
[npm-url]: https://www.npmjs.com/package/@scaleflex/widget-informer
|
|
74
|
+
[license-url]: https://opensource.org/licenses/MIT
|
|
75
|
+
[sfx-url]: https://www.scaleflex.com/
|
|
76
|
+
[version-url]: https://www.npmjs.com/package/@scaleflex/widget-informer
|
|
77
|
+
[codeSandbox-url]: https://codesandbox.io/p/sandbox/scalelfex-widget-v4-sandbox-dtp6l3?file=%2Fsrc%2Findex.js
|
|
78
|
+
|
|
79
|
+
[npm-image]: https://img.shields.io/npm/v/@telus/remark-config.svg?style=for-the-badge&logo=npm
|
|
80
|
+
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=for-the-badge
|
|
81
|
+
[made-by-image]: https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%99%A5%20by-the%20Scaleflex%20team-6986fa.svg?style=for-the-badge
|
|
82
|
+
[plugins-image]: https://img.shields.io/static/v1?label=Scaleflex&message=Plugins&color=yellow&style=for-the-badge
|
|
83
|
+
[filerobot-image]: https://img.shields.io/static/v1?label=Scaleflex&message=website&color=orange&style=for-the-badge
|
|
84
|
+
[filerobot-version]: https://img.shields.io/npm/v/@scaleflex/widget-informer?label=Version&style=for-the-badge&logo=npm
|
|
85
|
+
[codeSandbox-image]: https://img.shields.io/badge/CodeSandbox-black?style=for-the-badge&logo=CodeSandbox
|
package/lib/index.js
CHANGED
|
@@ -30,12 +30,12 @@ import InformerUI from './InformerUI';
|
|
|
30
30
|
// import { version } from '../package.json'
|
|
31
31
|
// import packageInfo from '../package.json'
|
|
32
32
|
|
|
33
|
-
/**
|
|
34
|
-
* Informer
|
|
35
|
-
* Shows rad message bubbles
|
|
36
|
-
* used like this: `filerobot.info('hello world', 'info', 5000)`
|
|
37
|
-
* or for errors: `filerobot.info('Error uploading img.jpg', 'error', 5000)`
|
|
38
|
-
*
|
|
33
|
+
/**
|
|
34
|
+
* Informer
|
|
35
|
+
* Shows rad message bubbles
|
|
36
|
+
* used like this: `filerobot.info('hello world', 'info', 5000)`
|
|
37
|
+
* or for errors: `filerobot.info('Error uploading img.jpg', 'error', 5000)`
|
|
38
|
+
*
|
|
39
39
|
*/
|
|
40
40
|
var Informer = /*#__PURE__*/function (_Plugin) {
|
|
41
41
|
// static VERSION = packageInfo.version
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scaleflex/widget-informer",
|
|
3
3
|
"description": "A notification and error pop-up bar for Scaleflex.",
|
|
4
|
-
"version": "4.0
|
|
4
|
+
"version": "4.1.0",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "lib/index.js",
|
|
7
7
|
"style": "dist/style.min.css",
|
|
@@ -16,9 +16,9 @@
|
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
18
|
"@scaleflex/ui": "^3.0.0-beta.11",
|
|
19
|
-
"@scaleflex/widget-common": "^4.0
|
|
20
|
-
"@scaleflex/widget-icons": "^4.0
|
|
21
|
-
"@scaleflex/widget-utils": "^4.0
|
|
19
|
+
"@scaleflex/widget-common": "^4.1.0",
|
|
20
|
+
"@scaleflex/widget-icons": "^4.1.0",
|
|
21
|
+
"@scaleflex/widget-utils": "^4.1.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"react": "^19.0.0",
|
|
@@ -30,5 +30,5 @@
|
|
|
30
30
|
"react": ">=19.0.0",
|
|
31
31
|
"react-dom": ">=19.0.0"
|
|
32
32
|
},
|
|
33
|
-
"gitHead": "
|
|
33
|
+
"gitHead": "471120d67066617a0d8824eae11b07d1f2259473"
|
|
34
34
|
}
|
package/types/index.d.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
import Filerobot = require("@scaleflex/widget-core");
|
|
2
|
-
|
|
3
|
-
declare module Informer {
|
|
4
|
-
interface InformerOptions extends Filerobot.PluginOptions {
|
|
5
|
-
replaceTargetContent?: boolean;
|
|
6
|
-
target?: Filerobot.PluginTarget;
|
|
7
|
-
}
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
declare class Informer extends Filerobot.Plugin<Informer.InformerOptions> {}
|
|
11
|
-
|
|
12
|
-
export = Informer;
|
|
1
|
+
import Filerobot = require("@scaleflex/widget-core");
|
|
2
|
+
|
|
3
|
+
declare module Informer {
|
|
4
|
+
interface InformerOptions extends Filerobot.PluginOptions {
|
|
5
|
+
replaceTargetContent?: boolean;
|
|
6
|
+
target?: Filerobot.PluginTarget;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
declare class Informer extends Filerobot.Plugin<Informer.InformerOptions> {}
|
|
11
|
+
|
|
12
|
+
export = Informer;
|