Appboard/2.4/builder/widgets/html widget - Revision history

imported>Jason.nicholls: /* HTML Widget Configuration */

2014-04-10T07:42:40Z

HTML Widget Configuration

← Older revision		Revision as of 07:42, 10 April 2014
Line 26:		Line 26:

	# Selection of Widget Type and Data Collection		# Selection of Widget Type and Data Collection
	# ''Options'' Configuration		# ''[[appboard/2.4/builder/widgets/options\|Options]]'' Configuration
	# ''Actions'' Configuration		# ''[[appboard/2.4/builder/widgets/actions\|Actions]]'' Configuration

	However, widget specific configuration needs to be implemented and made available by the widget itself. As a result HTML Widgets may not offer any configuration, or if there is configuration it may be made available in different ways.		However, widget specific configuration needs to be implemented and made available by the widget itself. As a result HTML Widgets may not offer any configuration, or if there is configuration it may be made available in different ways.

2014-04-10T07:41:15Z

HTML Widget (Specific) Configuration

← Older revision		Revision as of 07:41, 10 April 2014
Line 21:		Line 21:


	== HTML Widget ~~(Specific)~~ Configuration ==		== HTML Widget Configuration ==

	~~Although~~ HTML ~~Widget~~ configuration ~~is stored~~ with ~~AppBoard~~ the ~~actual~~ configuration ~~interface must~~ be ~~provided~~ by the widget itself. ~~This differs from native widgets where the~~ configuration ~~options are provided when editing the widget~~.		HTML Widgets share common configuration with native widgets for the following areas:

			# Selection of Widget Type and Data Collection
			# ''Options'' Configuration
			# ''Actions'' Configuration

			However, widget specific configuration needs to be implemented and made available by the widget itself. As a result HTML Widgets may not offer any configuration, or if there is configuration it may be made available in different ways.

	The exampleTableWidget shipped with AppBoard provides an example implementation of widget specific configuration, refer to the image below:		The exampleTableWidget shipped with AppBoard provides an example implementation of widget specific configuration, refer to the image below:

	[[File:appboard-2.4-html-example-table-widget.png\|frame\|exampleTableWidget - HTML Widget provided with AppBoard, showing the widget configuration]]		[[File:appboard-2.4-html-example-table-widget.png\|frame\|exampleTableWidget - HTML Widget provided with AppBoard, showing the widget configuration]]

2014-04-10T07:37:33Z

← Older revision		Revision as of 07:37, 10 April 2014
Line 19:		Line 19:

	[[File:appboard-2.4-html-widget-selection.png\|frame\|Widget Type selection dialog]]		[[File:appboard-2.4-html-widget-selection.png\|frame\|Widget Type selection dialog]]


			== HTML Widget (Specific) Configuration ==

			Although HTML Widget configuration is stored with AppBoard the actual configuration interface must be provided by the widget itself. This differs from native widgets where the configuration options are provided when editing the widget.

			The exampleTableWidget shipped with AppBoard provides an example implementation of widget specific configuration, refer to the image below:

			[[File:appboard-2.4-html-example-table-widget.png\|frame\|exampleTableWidget - HTML Widget provided with AppBoard, showing the widget configuration]]

2014-04-10T07:29:46Z

Using HTML Widgets

← Older revision		Revision as of 07:29, 10 April 2014
Line 18:		Line 18:
	For instructions on creating an instance of a HTML Widget, see the general instructions in [[appboard/2.4/builder/widgets#Adding_Widgets\|Adding Widgets]]. The '''HTML Widget''' is located under the '''Web''' category on the Widget Type selection screen.		For instructions on creating an instance of a HTML Widget, see the general instructions in [[appboard/2.4/builder/widgets#Adding_Widgets\|Adding Widgets]]. The '''HTML Widget''' is located under the '''Web''' category on the Widget Type selection screen.

	[[File:appboard-2.4-html-widget-selection.png]]		[[File:appboard-2.4-html-widget-selection.png\|frame\|Widget Type selection dialog]]

2014-04-10T07:28:49Z

← Older revision		Revision as of 07:28, 10 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:HTML Widget}}		{{DISPLAYTITLE:HTML Widget}}
	[[Category:AppBoard 2.4]]		[[Category:AppBoard 2.4]]

			The '''HTML Widget''' is not a specific widget but provides access to custom HTML widgets made available through the HTML Widget API. AppBoard ships with an example HTML table widget for experimentation out of the box.

			HTML Widgets using the API are able to behave as native widgets:

			* Linked to data collections. Any changes to the data collections such as through server side filter actions are reflected in the HTML Widget.
			* Standard Widget ''Options'' such as text search, quick filters, and data collection download.
			* HTML Widget is able to trigger standard AppBoard actions. These are defined on the widget just like a native widget.
			* HTML Widgets can also have their own configuration which is stored with AppBoard. This ensures a consistent way to backup/restore configuration and allow for separate configured instances of the same HTML Widget type.

			For more information on creating HTML Widgets please refer to the [[appboard/2.4/builder/widgets/html_widget/api\|API documentation]].


			== Using HTML Widgets ==

			For instructions on creating an instance of a HTML Widget, see the general instructions in [[appboard/2.4/builder/widgets#Adding_Widgets\|Adding Widgets]]. The '''HTML Widget''' is located under the '''Web''' category on the Widget Type selection screen.

			[[File:appboard-2.4-html-widget-selection.png]]

2014-04-03T07:38:05Z

Created page with '{{DISPLAYTITLE:HTML Widget}} Category:AppBoard 2.4'

New page

{{DISPLAYTITLE:HTML Widget}}
[[Category:AppBoard 2.4]]