@wasl-flow/jquery
v1.0.1
Published
jQuery renderer for Wasl Flow
Maintainers
Readme
@wasl-flow/jquery
jQuery renderer for wasl-flow. It renders content models into jQuery objects.
Install
npm install wasl-flow @wasl-flow/jquery jquery
# or
pnpm add wasl-flow @wasl-flow/jquery jqueryQuick Start
import $ from 'jquery';
import { JQueryRenderer } from '@wasl-flow/jquery';
type ButtonModel = { type: 'button'; text: string };
const renderer = new JQueryRenderer({ showValidationErrors: true });
renderer.register({
type: 'button',
parse: model => ({ data: model as ButtonModel }),
factory: ({ model }) => $('<button>').addClass('btn-primary').text(model.text),
});
const $button = renderer.render({ type: 'button', text: 'Click me' }) as JQuery;
$('body').append($button);Renderer Behavior
renderreturns aJQueryobject.renderArrayaggregates outputs into a single jQuery object. Multiple elements are wrapped in a container<div>.- Default
nullValueis an empty jQuery object ($()). - When
showValidationErrorsis enabled, errors are rendered as styled jQuery elements with sanitized details.
Configuration
All RendererConfiguration options from the core package are supported. This renderer only changes the default nullValue to an empty jQuery object.
For details on registration, parsing, and safety limits, see the core package README.
