profectus-docs/assets/api_interfaces_game_layers.LayerOptions.md.01801654.js

import{_ as e,c as a,o as t,a as r}from"./app.ab34650d.js";const m=JSON.parse('{"title":"Interface: LayerOptions","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"classes","slug":"classes"},{"level":3,"title":"color","slug":"color"},{"level":3,"title":"display","slug":"display"},{"level":3,"title":"forceHideGoBack","slug":"forcehidegoback"},{"level":3,"title":"minWidth","slug":"minwidth"},{"level":3,"title":"minimizable","slug":"minimizable"},{"level":3,"title":"name","slug":"name"},{"level":3,"title":"style","slug":"style"}],"relativePath":"api/interfaces/game/layers.LayerOptions.md","lastUpdated":null}'),o={name:"api/interfaces/game/layers.LayerOptions.md"},s=r('<h1 id="interface-layeroptions" tabindex="-1">Interface: LayerOptions <a class="header-anchor" href="#interface-layeroptions" aria-hidden="true">#</a></h1><p><a href="./../../modules/game/layers.html">game/layers</a>.LayerOptions</p><p>An object that configures a <a href="./../../modules/game/layers.html#layer">Layer</a>. Even moreso than features, the developer is expected to include extra properties in this object. All <a href="./../../modules/game/persistence.html#persistent">Persistent</a> refs must be included somewhere within the layer object.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>classes</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</p><p>An object of classes that should be applied to the display.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L116" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:116</a></p><hr><h3 id="color" tabindex="-1">color <a class="header-anchor" href="#color" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>color</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</p><p>The color of the layer, used to theme the entire layer&#39;s display.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L109" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:109</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-hidden="true">#</a></h3><p>\u2022 <strong>display</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><p>The layout of this layer&#39;s features. When the layer is open in <a href="./player.PlayerData.html#tabs">tabs</a>, this is the content that is display.</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L114" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:114</a></p><hr><h3 id="forcehidegoback" tabindex="-1">forceHideGoBack <a class="header-anchor" href="#forcehidegoback" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>forceHideGoBack</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not to force the go back button to be hidden. If true, go back will be hidden regardless of data/projInfo.allowGoBack.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L133" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:133</a></p><hr><h3 id="minwidth" tabindex="-1">minWidth <a class="header-anchor" href="#minwidth" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>minWidth</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>string</code> | <code>number</code>&gt;</p><p>A CSS min-width value that is applied to the layer. Can be a number, in which case the unit is assumed to be px. Defaults to 600px.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L139" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:139</a></p><hr><h3 id="minimizable" tabindex="-1">minimizable <a class="header-anchor" href="#minimizable" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>minimizable</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not the layer can be minimized. Defaults to true.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L128" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:128</a></p><hr><h3 id="name" tabindex="-1">name <a class="header-anchor" href="#name" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>name</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</p><p>The name of the layer, used on minimized tabs. Defaults to <a href="./layers.BaseLayer.html#id">id</a>.</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L123" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:123</a></p><hr><h3 id="style" tabindex="-1">style <a class="header-anchor" href="#style" aria-hidden="true">#</a></h3><p>\u2022 <code>Optional</code> <strong>style</strong>: <a href="./../../modules/util/computed.html#computable"><code>Computable</code></a>&lt;<a href="./../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;</p><p>Styles that should be applied to the display.</p><h4 id="defined-in-7" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-7" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/013092f/src/game/layers.tsx#L118" target="_blank" rel="noopener noreferrer">profectus/src/game/layers.tsx:118</a></p>',51),i=[s];function n(d,l,c,h,p,f){return t(),a("div",null,i)}var b=e(o,[["render",n]]);export{m as __pageData,b as default};