This documentation is currently being moved to our new documentation site.

Please view or edit the documentation there, instead.

If you're looking for Fluid Project coordination, design, communication, etc, try the Fluid Project Wiki.

fluid.renderer.createRendererSubcomponent

Owned by Anastasia Cheetham
Last updated: Nov 11, 2013Version comment
1 min read

This functionality is Sneak Peek status. This means that the APIs may change. We welcome your feedback, ideas, and code, but please use caution if you use this new functionality.

This page is still being drafted and is incomplete at this time.

fluid.renderer.createRendererSubcomponent(container, selectors, options, model, fossils)

description

fluid.renderer.createRendererSubcomponent(container, selectors, options, model, fossils);

File name: RendererUtilities.js

Parameters

container (jQueryable) A string selector, DOM node or jQuery object that is the container for this renderer function.
selectors (Object) A set of named selectors strings (key/value pairs where the key is the selector name and the value is the string selector).
options (Object) Options that will control the behaviour of the renderer function. See Options below for more information.
model (Object) The data model that is to be rendered.
fossils (Object) (optional)

Return Value

Object A renderer subcomponent. For more information, see Return Value below.

 

See Also

 

 

Options

Name

Description

Values

Default

cutpointGenerator

A function that can be used to create a list of cutpoints.NOTE that this function will only be used if the rendererOptions option does not include a cutpoints entry.

function

fluid.renderer.selectorsToCutpoints

expanderOptions

Options that will be passed on to the prototree expander function. Note that if the noexpand option is true, these options will be ignored.

Object

none

noexpand

A flag that, if true, will prevent the prototree from undergoing any expansion. NOTE that this option will render any expanderOptions meaningless.

boolean

false

rendererOptions

Options that will be passed on to the Renderer itself. See fluid.render for more information

Object

none

templateSource

A string selector, DOM node or jQuery object containing the source template to be used for rendering by this function.

jQueryable

none; The container will be used as the source for the template if this option is not provided.

Return Value

This function returns a renderer subcomponent with two public methods:

  • expander:
  • render: when invoked, this function will render the prototree into the container

Example

example here

In this example, description here...