Child pages
  • fluid.renderer.makeProtoExpander

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

Include Page
sneak peek warning
sneak peek warning
Warning

This page is in the process of being drafted and is still incomplete.

Wiki Markup
{div:class=api-page}

h1. fluid.renderer.makeProtoExpander(expandOptions)
{section}
{column:width=70%}

Create a "protoComponent expander" with the supplied set of options.

{code:javascript|borderStyle=none|bgColor=white}
fluid.renderer.makeProtoExpander(expandOptions);
{code}

*File name:* {{RendererUtilities.js}}

h2. Parameters

{span:class=borderless-table}
|*{{expandOptions}}*| (Object) Options for controlling the expansion. For more information, see [#Options] below.|
{span}

h2. Return Value
{span:class=borderless-table}
|*Function*| A function which accepts a [protoComponent|ProtoComponent Types] tree as argument, and returns a fully expanded [Component Tree|Renderer Component Trees] suitable for supplying to the renderer. |
{span}

{column}

{column:width=5%}
{column}

{column}
h3. See Also
* [fluid.initRendererComponent]
* [fluid.renderer.createRendererFunction]
{column}
{section}
----

h3. Options

||Name||Description||Values||Default||
|{{ELstyle}}| The format to be used for identifying values to be expanded in the protocomponent tree.|String|{{"${}"}}|
|{{IDescape}}| | String| {{"\\\"}}|
|{{model}}| Configuration functions to be applied to any data retrieved from the model|Object | none |
|{{resolverGetConfig}}| Configuration functions to be applied to any data retrieved from the model.| Array of functions | none |

h3. Example
{code:javascript}
example here
{code}
In this example, description here...

{div}