ForgeComponents
en

Components

j-LargeForm

jComponent 20 · jcomponent@20 component Example loaded with jComponent 20

Configuration:

  • title {String} form title
  • width {Number} form max-width
  • if {String} condition for showing of the form, it's compared with the value within of path
  • icon {String} Total icon without ti- or new: ti ti-home
  • reload {String} link to a global function(largeform_component) and it's executed if the form is displaying
  • submit {String} link to a global function(hide) and it's executed if the submit button is pressed
  • cancel {String} link to a global function(hide) and it's executed if the cancel button is pressed
  • enter {Boolean} captures enter key automatically and performs submit (default: false)
  • center {Boolean} centers the form to middle of screen
  • autofocus {Boolean/String} can focus an input. String === jQuery selector for the input
  • default {String} a short alias for DEFAULT(default, true)
  • closebutton {Boolean} can hide x button (default: false)
  • zindex {Number} can affect z-index (default: 12)
  • scrollbar {Boolean} enables custom scrollbar (default: true)
  • scrolltop {Boolean} enables scrolling to top after form is displayed (default: true)
  • scrollbarshadow {Boolean} optional, enables a shadow in scrollbar (default: false)
  • style {Number} supports two styles (1: classic (default), 2: bottom of for is without padding)
  • closeoutside {Boolean} closes the form when the user clicks outside of the form (default: false)
  • closeesc {Boolean} closes the form when the user presses ESC key
  • independent {Boolean} closing doesn't depent on the condition according to the path
  • close {String} link to a global function() and it's executed if the form is closing
  • NEW hide {String} link to a global function() and it's executed if the form hides

Good to know:

New version of this component supports dynamic evaluation of the content of <script type="text/html">. The example below contains a script with HTML and the component evaluates the content if the j-Form will be displayed (only once).

<ui-component name="largeform" path="path" config="config">
	<script type="text/html">
		A CONTENT
	</script>
</ui-component>

Use it with <ui-component name="largeform">. When the component is not loaded yet, jComponent downloads it on first use from the address in DEF.fallback (the Componentator CDN by default). Author: Peter Širka. Source: the Componentator components repository, MIT license.

example.html
<ui-component name="largeform" path="common.form" config="if:user;width:500;title:Title;submit:userform_submit" class="hidden">
	<div class="padding">
		SOME CONTENT
	</div>
	<nav>
		<button name="submit">SUBMIT</button>
		<button name="cancel">CANCEL</button>
	</nav>
</ui-component>

<script>

	function userform_submit(hide) {
		alert('SUBMIT');
		hide();
	}

	var common = {};

	// Show the form
	common.form = 'user';
</script>