Merge pull request #8 from SpringRoll/main

Merging changes to update fork

Author: wrbright

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+* @902seanryan @aberkie @deycorinne

.github/workflows/build.yml

@@ -1,6 +1,6 @@
 name: build
 
-on: 
+on:
   pull_request:
     paths-ignore:
      - 'docs/**'
@@ -9,15 +9,15 @@ on:
   push:
     branches:
       - main
-  
+
 jobs:
   build:
 
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [8.x, 10.x, 12.x]
+        node-version: [10.x, 12.x, 14.x]
 
     steps:
     - uses: actions/checkout@v1
@@ -32,7 +32,7 @@ jobs:
         npm ci
       env:
         CI: true
-    
+
     - name: build
       run: |
         npm run build
@@ -44,4 +44,4 @@ jobs:
         npm run github-test
       env:
         CI: true
-    
+

.github/workflows/npm-deploy.yaml

@@ -3,6 +3,7 @@ name: npm-deploy
 on:
   release:
     types: [created]
+  workflow_dispatch:
 
 jobs:
   publish-npm:

.gitignore

@@ -3,6 +3,7 @@ node_modules
 docs
 .grunt
 .env
+.DS_Store
 e2e/client.js
 local.log
 .DS_Store

.nvmrc

@@ -1 +1 @@
-v8.11.3
+v10.15.3

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.2.1] - 2021-03-04
+### Changed
+- socket.io dependency version bump
+
+## [2.2.0] - 2021-02-19
+### Added
+- This CHANGELOG
+- Fullscreen Plugin. The ability to add in a fullscreen button within container
+- Fullscreen Plugin Automated Testing
+- Fullscreen Plugin Documentation
+- Indexeddb additions to the userdata class
+### Changed
+- update NPM modules to remove security vulnerabilities

README.md

@@ -359,6 +359,56 @@ container.openPath('game.html');
 any unsupported values. See [the SpringRoll Application Class docs](https://github.com/SpringRoll/SpringRoll/tree/v2/src#handling-state-change)
 for more information on the request format.
 
+### Fullscreen Plugin
+The fullscreen plugin hooks up an element or elements to set the iframe to full screen then communicates this through Bellhop. The plugin will also add the class ```'--fullScreen'``` to the element(s) given
+
+```javascript
+import { FullScreenPlugin, Container } from  'springroll-container';
+
+const container = new Container('#game', {
+
+  plugins: [
+    // FullScreenPlugin expects the selector for the element(s) to hook onto
+    new FullScreenPlugin('#fullScreenButton'),
+  ]
+  });
+
+container.openPath('game.html');
+
+```
+
+The plugin will accept either a selector or an array of selectors as a parameter
+
+```javascript
+new FullScreenPlugin('#fullScreenButton');
+new FullScreenPlugin(['#fullScreenButton', '.fullScreenButtonSideNav']);
+
+// It will also accept one string with all selectors each seperated by a comma
+new FullScreenPlugin('#fullScreenButton, .fullScreenButtonSideNav');
+
+
+```
+
+The typical html can look something like this however, the element may be positioned anywhere in the html as long as it is not inside the iframe
+  
+
+```html
+
+<nav>
+  <!-- May be a button or any other element that can create an onclick event -->
+  <button id='fullScreenButton'>Fullscreen</button>
+</nav>
+<!-- The element cannot be inside the source file -->
+<iframe id="game" scrolling="no"></iframe>
+
+
+```
+isFullScreen returns true if there is a fullscreen element
+`` FullScreenPlugin.isFullScreen ``
+
+
+---
+
 ### Multiple Plugin Controls
 All Plugins accept one or more HTML elements as controls in their constructor.
 For example the SoundPlugin can accept more than one volume slider or button if your set up requires it:
@@ -412,6 +462,7 @@ used to store user data for use across the Springroll environment. Examples are
 The `SavedData` class is the most direct way to access the Container storage options. It is used primarily in plugin classes, but may
 be used wherever necessary.
 
+Following is an example of interacting with Local Storage
 ```javascript
 import { SavedData } from 'springroll-container';
 
@@ -426,6 +477,18 @@ let data = SavedData.read('user-value-key'); //data will be either the value in
 SavedData.remove('user-value-key'); //removes the value from both local and session storage.
 ```
 
+Following is an example of interacting with [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) through the UserData class
+
+
+``` javascript
+import { SavedData } from 'springroll-container';
+
+// Firstly, construct the SavedData object. This is only needed for IndexedDB work
+savedData = new SavedData('dbName');
+```
+All other methods will work the same as the documentation [here](https://github.com/SpringRoll/SpringRoll/tree/main/src/state#userdata);
+
+
 ### SavedDataHandler
 The SavedDataHandler class is used primarily in the `UserDataPlugin` to interact with the `SavedData` class. But can be used directly
 if you require a callback when reading or writing from `SavedData`. Like `SavedData` all of the methods are static.