You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 8, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
8
8
## [3.0.0] - 2025-01-03
9
9
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").
11
11
12
12
### Changed
13
13
@@ -17,7 +17,7 @@ This is the start of the websquad's fork of https://github.com/springroll/Spring
17
17
18
18
### Fixed
19
19
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
21
21
22
22
## [2.5.1] - 2024-04-16
23
23
@@ -29,13 +29,13 @@ This is the start of the websquad's fork of https://github.com/springroll/Spring
29
29
30
30
### Changed
31
31
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.
34
34
- updated .nvmrc to 18
35
35
36
36
### Added
37
37
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.
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).
93
93
94
94
The Container has several built-in plugins that allow the user to control various aspects of a game/application.
95
95
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))
Copy file name to clipboardExpand all lines: src/plugins/README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,37 +75,37 @@ export class MyPlugin {
75
75
## Internal a.k.a. Built-In Plugins
76
76
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.
The most barebones plugin class avaialable. Should be used if none of the other plugins match your needs.
81
81
Provides very basic implementations of `preload()`, `init()`, and `start()`.
82
82
83
83
| It also provides a few useful helper functions: ||
84
84
| --- | --- |
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 |
86
86
|`warn(warningText)`| prints out an informative console warning |
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.
92
92
| It also includes: ||
93
93
| --- | --- |
94
94
| `_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.
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.
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.
104
104
105
105
### UI-Elements
106
106
Container also provides a few base ui-element classes to help set up any HTML controls you have. These are:
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