README.md

settingspanel.js

hideable UI to change game settings during runtime

Live Example

https://davidfig.github.io/settingspanel/

Installation

npm i settingspanel

API Reference

SettingsPanel

a settings panel for changing and watching parameters during runtime

Kind: global class

• SettingsPanel
  • new SettingsPanel([options])
  • .button(text, callback, [options])
  • .input(label, callback, [options])
  • .hide()
  • .show()
  • .side(side)

new SettingsPanel([options])

Param	Type	Default	Description
[options]	object
[options.style]	object		CSS style to apply to the parent div
[options.parent]	object	document.body	where to append div
[options.color]	string	"'white'"	default foreground
[options.background]	string	"'black'"	default background
[options.open]	boolean	true	show when starting
[options.side]	string	"'right'"	change side: 'left' or 'right'

settingsPanel.button(text, callback, [options])

adds a button with callback

Kind: instance method of SettingsPanel

Param	Type	Description
text	string	to display
callback	function	on button click if returns a value, then replaces button text with [text + result]
[options]	object
[options.original]	object	original settings for button - sets text as [text + original] change through callback (see above)
[options.color]	string	foreground color
[options.background]	string	background color
[options.style]	object	CSS for button

settingsPanel.input(label, callback, [options])

adds an input panel

Kind: instance method of SettingsPanel

Param	Type	Description
label	string	text
callback	function	on change input
[options]	object
[options.original]	object	original settings for input
[options.color]	string	foreground color
[options.background]	string	background color
[options.style]	object	CSS for button
[options.sameLine]	boolean	same line for label and text
[options.size]	number	size (number of characters) of input box

settingsPanel.hide()

hides the SettingsPanel

Kind: instance method of SettingsPanel

settingsPanel.show()

shows the SettingsPanel

Kind: instance method of SettingsPanel

settingsPanel.side(side)

change side of panel

Kind: instance method of SettingsPanel

Param	Type	Description
side	string	'left' or 'right'

---

Copyright (c) 2017 YOPEY YOPEY LLC - MIT License - Documented by jsdoc-to-markdown