fix: rename default to div 'game'

Sebring · Oct 12, 2021 · d32caa0 · d32caa0
1 parent c1295a1
commit d32caa0
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/lib/crafty/core/core.js b/lib/crafty/core/core.js
@@ -1366,7 +1366,7 @@ Crafty.extend({
      * @param Number height - Height of the stage
      * @param String or HTMLElement stage_elem - the element to use for the stage
      *
-     * Sets the element to use as the stage, creating it if necessary.  By default a div with id 'cr-stage' is used, but if the 'stage_elem' argument is provided that will be used instead.  (see `Crafty.viewport.init`)
+     * Sets the element to use as the stage, creating it if necessary.  By default a div with id 'game' is used, but if the 'stage_elem' argument is provided that will be used instead.  (see `Crafty.viewport.init`)
      *
      * Starts the `UpdateFrame` interval. This will call the `UpdateFrame` event for every frame.
      *

diff --git a/lib/crafty/graphics/dom-layer.js b/lib/crafty/graphics/dom-layer.js
@@ -20,7 +20,7 @@ Crafty._registerLayerTemplate("DOM", {
      * @kind Property
      * @private
      * 
-     * A div inside the `#cr-stage` div that holds all DOM entities.
+     * A div inside the `#game` div that holds all DOM entities.
      */
     _div: null,
 

diff --git a/lib/crafty/graphics/viewport.js b/lib/crafty/graphics/viewport.js
@@ -576,7 +576,7 @@ Crafty.extend({
          *
          * Initialize the viewport.
          * If the arguments 'width' or 'height' are missing, use `window.innerWidth` and `window.innerHeight` (full screen model).
-         * The argument 'stage_elem' is used to specify a stage element other than the default, and can be either a string or an HTMLElement.  If a string is provided, it will look for an element with that id and, if none exists, create a div.  If an HTMLElement is provided, that is used directly.  Omitting this argument is the same as passing an id of 'cr-stage'.
+         * The argument 'stage_elem' is used to specify a stage element other than the default, and can be either a string or an HTMLElement.  If a string is provided, it will look for an element with that id and, if none exists, create a div.  If an HTMLElement is provided, that is used directly.  Omitting this argument is the same as passing an id of 'game'.
          *
          * Usually you don't have to initialize the viewport by yourself, it's automatically initialized by calling `Crafty.init()`. Multiple `init`s will create redundant stage elements. Use `Crafty.viewport.width`, `Crafty.viewport.height` or `Crafty.viewport.reload` to adjust the current viewport's dimensions.
          *
@@ -611,7 +611,7 @@ Crafty.extend({
 
             //check if stage exists
             if (typeof stage_elem === 'undefined')
-                stage_elem = "cr-stage";
+                stage_elem = "game";
 
             var crstage;
             if (typeof stage_elem === 'string')
@@ -634,7 +634,7 @@ Crafty.extend({
              * @comp Crafty.stage
              * @kind Property
              * 
-             * The `#cr-stage` div element.
+             * The `#game` div element.
              */
 
             //create stage div to contain everything

diff --git a/src/freerunner.ts b/src/freerunner.ts
@@ -41,7 +41,7 @@ export declare interface FGame {
     cc<T extends CComponent>(component: CComponent) : T
     e<T extends Entity>(components: string): T
     fps: number
-    init(width?:number, height?:number, element?:HTMLElement|null): this
+    init(width?:number, height?:number, element?:HTMLElement|string|null): this
 
     /**
      * Set background color to html color name.