Skip to content
This repository was archived by the owner on May 8, 2025. It is now read-only.

Commit 737f4fe

Browse files
authored
Merge pull request #6 from pbs/chore/update-version
Update version number and repo path
2 parents c6095dc + 67d2bca commit 737f4fe

File tree

8 files changed

+28
-27
lines changed

8 files changed

+28
-27
lines changed

CHANGELOG.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [3.0.0] - 2025-01-03
99

10-
This is the start of the websquad's fork of https://github.com/springroll/SpringRollContainer to be used in the pbskids redesign (project name "Puma").
10+
This is the start of the websquad's fork of https://github.com/pbs/SpringRollContainer to be used in the pbskids redesign (project name "Puma").
1111

1212
### Changed
1313

@@ -17,7 +17,7 @@ This is the start of the websquad's fork of https://github.com/springroll/Spring
1717

1818
### Fixed
1919

20-
- Ensured that CaptionsTogglePlugin internal state is maintained when reading from localStorage on startup
20+
- Ensured that CaptionsTogglePlugin internal state is maintained when reading from localStorage on startup
2121

2222
## [2.5.1] - 2024-04-16
2323

@@ -29,13 +29,13 @@ This is the start of the websquad's fork of https://github.com/springroll/Spring
2929

3030
### Changed
3131

32-
- Prevent SoundPlugin from sending mute state before Application is loaded.
33-
- Prevent CaptionsTogglePlugin from sending mute state before Application is loaded.
32+
- Prevent SoundPlugin from sending mute state before Application is loaded.
33+
- Prevent CaptionsTogglePlugin from sending mute state before Application is loaded.
3434
- updated .nvmrc to 18
3535

3636
### Added
3737

38-
- Added a check to make sure plugin preloads are finished before opening up the application to avoid race conditions.
38+
- Added a check to make sure plugin preloads are finished before opening up the application to avoid race conditions.
3939

4040
## [2.4.6] - 2023-10-16
4141

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ container.openPath('/path/to/game.html');
8989

9090
## Plugins
9191

92-
This section provides instructions on how to use the built-in plugins for SpringRoll Container. For writing or updating older plugins, see the [Plugin Authoring Guide](https://github.com/SpringRoll/SpringRollContainer/tree/main/src/plugins).
92+
This section provides instructions on how to use the built-in plugins for SpringRoll Container. For writing or updating older plugins, see the [Plugin Authoring Guide](https://github.com/pbs/SpringRollContainer/tree/main/src/plugins).
9393

9494
The Container has several built-in plugins that allow the user to control various aspects of a game/application.
9595
These are initialized with either a query selector string (similar to what you would pass to [document.querySelector](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector))

dist/SpringRoll-Container-umd.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "springroll-container",
3-
"version": "2.5.2",
3+
"version": "3.0.0",
44
"description": "The iframe controller for interacting with SpringRoll applications",
55
"main": "./dist/index.js",
66
"license": "MIT",
77
"typings": "typings/index.d.ts",
88
"repository": {
99
"type": "git",
10-
"url": "https://github.com/SpringRoll/SpringRollContainer"
10+
"url": "https://github.com/pbs/SpringRollContainer"
1111
},
1212
"devDependencies": {
1313
"@babel/core": "^7.4.3",
@@ -70,7 +70,7 @@
7070
},
7171
"readmeFilename": "README.md",
7272
"bugs": {
73-
"url": "https://github.com/SpringRoll/SpringRollContainer/issues"
73+
"url": "https://github.com/pbs/SpringRollContainer/issues"
7474
},
75-
"homepage": "https://github.com/SpringRoll/SpringRollContainer"
75+
"homepage": "https://github.com/pbs/SpringRollContainer"
7676
}

src/plugins/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -75,37 +75,37 @@ export class MyPlugin {
7575
## Internal a.k.a. Built-In Plugins
7676
If you're developing for SpringrollContainer directly the process is still the same but there are base plugin classes available to keep your plugins DRY and more consistent.
7777

78-
### [BasePlugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/base-plugins/BasePlugin.js)
79-
[Example Plugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/plugins/KeyboardMapPlugin.js)
78+
### [BasePlugin](https://github.com/pbs/SpringRollContainer/blob/main/src/base-plugins/BasePlugin.js)
79+
[Example Plugin](https://github.com/pbs/SpringRollContainer/blob/main/src/plugins/KeyboardMapPlugin.js)
8080
The most barebones plugin class avaialable. Should be used if none of the other plugins match your needs.
8181
Provides very basic implementations of `preload()`, `init()`, and `start()`.
8282

8383
| It also provides a few useful helper functions: | |
8484
| --- | --- |
85-
| `SendProperty(prop, value)` | Sends a single property and it's value through Bellhop to the application. `prop` should match the springroll feature name. Also [saves the property](https://github.com/SpringRoll/SpringRollContainer#saved-data-api) for re-use |
85+
| `SendProperty(prop, value)` | Sends a single property and it's value through Bellhop to the application. `prop` should match the springroll feature name. Also [saves the property](https://github.com/pbs/SpringRollContainer#saved-data-api) for re-use |
8686
| `warn(warningText)` | prints out an informative console warning |
8787
---
8888

89-
### [ButtonPlugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/base-plugins/ButtonPlugin.js)
90-
[Example Plugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/plugins/CaptionsTogglePlugin.js)
89+
### [ButtonPlugin](https://github.com/pbs/SpringRollContainer/blob/main/src/base-plugins/ButtonPlugin.js)
90+
[Example Plugin](https://github.com/pbs/SpringRollContainer/blob/main/src/plugins/CaptionsTogglePlugin.js)
9191
The `ButtonPlugin` is useful for any plugin that requires a `mute` state (i.e. on or off). It extends the `BasePlugin` and has access to all of the methods above.
9292
| It also includes: | |
9393
| --- | --- |
9494
| `_setMuteProp(prop, button, muted)` | Sets the current state of the property, and sends it to the application. This also handles applying styles to the button or buttons to match. `button` can be a single instance of a button or an array of matching buttons.
9595
---
9696

97-
### [SliderPlugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/base-plugins/SliderPlugin.js)
98-
[Example Plugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/plugins/LayersPlugin.js)
97+
### [SliderPlugin](https://github.com/pbs/SpringRollContainer/blob/main/src/base-plugins/SliderPlugin.js)
98+
[Example Plugin](https://github.com/pbs/SpringRollContainer/blob/main/src/plugins/LayersPlugin.js)
9999
If your plugin requires a range input to control volume or a similar setting this plugin will handle most of it. It can only accept one setting to control however so if you require more than one setting (e.g. `MusicVolume` and `VoiceOverVolume`) consider breaking it out into multiple plugins or just using `BasePlugin`. If your plugin extends this base class all you have to do is pass the configuration options through the `super()` call and the `SliderPlugin` handles the rest.
100100

101-
### [RadioGroupPlugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/base-plugins/RadioGroupPlugin.js)
102-
[Example Plugin](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/plugins/ColorVisionPlugin.js)
101+
### [RadioGroupPlugin](https://github.com/pbs/SpringRollContainer/blob/main/src/base-plugins/RadioGroupPlugin.js)
102+
[Example Plugin](https://github.com/pbs/SpringRollContainer/blob/main/src/plugins/ColorVisionPlugin.js)
103103
The RadioGroupPlugin is used for any plugin that uses groups of radio buttons to allow selection between pre-determined options. Similarly to the SliderPlugin above, the RadioGroupPlugin handles most of the set up behind the scenes and you won't have to interact directly with any of its methods.
104104

105105
### UI-Elements
106106
Container also provides a few base ui-element classes to help set up any HTML controls you have. These are:
107-
- [Slider](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/ui-elements/Slider.js)
108-
- [Button](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/ui-elements/Button.js)
109-
- [RadioGroup](https://github.com/SpringRoll/SpringRollContainer/blob/main/src/ui-elements/RadioGroup.js)
107+
- [Slider](https://github.com/pbs/SpringRollContainer/blob/main/src/ui-elements/Slider.js)
108+
- [Button](https://github.com/pbs/SpringRollContainer/blob/main/src/ui-elements/Button.js)
109+
- [RadioGroup](https://github.com/pbs/SpringRollContainer/blob/main/src/ui-elements/RadioGroup.js)
110110

111111
Note: these are used automatically by the `RadioGroupPlugin` and `SliderPlugin`. So these should only be required if you're not using one of those two as your base.

0 commit comments

Comments
 (0)