Skip to content

Commit d346e3b

Browse files
committed
3.0.0
1 parent 6717a73 commit d346e3b

File tree

3 files changed

+20
-3
lines changed

3 files changed

+20
-3
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,22 @@ Directly launch your plugin.
6363

6464
### `defaults`
6565

66-
_`public`_
66+
> since v3.0.0 property renamed to `defaultSettings`
67+
68+
### `defaultSettings`
69+
70+
_`public`_
71+
_**`since v3.0.0`**_
6772

6873
A getter that returns an object with default options, settings, or configuration for your plugin.
6974

75+
### `defaultProps`
76+
77+
_`public`_
78+
_**`since v3.0.0`**_
79+
80+
A getter that returns an object with predefined props, which can be represented as a list of flags (aka properties API) that affects your settings, etc.
81+
7082
---
7183

7284
## Usage example

index.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
/**
44
* @module WebPluginInterface
55
* @author OlegDutchenko <[email protected]>
6+
* @version 3.0.0
67
*/
78

89
/**
@@ -38,7 +39,11 @@ export class WebPluginInterface {
3839
// code
3940
}
4041

41-
get defaults () {
42+
get defaultSettings () {
43+
return {};
44+
}
45+
46+
get defaultProps () {
4247
return {};
4348
}
4449
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "web-plugin-interface",
3-
"version": "2.0.2",
3+
"version": "3.0.0",
44
"description": "",
55
"main": "index.js",
66
"scripts": {

0 commit comments

Comments
 (0)