EZ HTML v2.0.2 Documentation

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

A simple library for programatically rendering HTML and client-side JavaScript using Node.js.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML input elements.

• data <Object>
• Returns <Input>

Returns a new <Input> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the types of files that the server accepts (only for input type file).

• types <string>
• Throws <TypeError> if types is not a valid <string>
• Returns <this>

Sets the types of files that the server accepts (only for input type file).

• Returns <string>

Gets the alternate text for the input.

• text <string>
• Throws <TypeError> if text is not a valid <string>
• Returns <this>

Sets the alternate text for the input.

• Returns <string>

Gets a flag inicating whether the browser should enable autocomplete for this input, can be on or off.

• flag <string>
• Throws <TypeError> if flag is not a valid <string>
• Returns <this>

Sets a flag inicating whether the browser should enable autocomplete for this input, can be on or off.

• Returns <boolean>

Gets a boolean indicating whether the button should automatically get focus when the page loads.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether the button should automatically get focus when the page loads.

• Returns <boolean>

Gets a boolean indicating whether this input should be checked on page load, only for input types checkbox or radio.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this input should be checked on page load, only for input types checkbox or radio.

• Returns <string>

Gets the direction of the text that will be submitted.

• dir <string>
• Throws <TypeError> if dir is not a valid <string>
• Returns <this>

Sets the direction of the text that will be submitted.

• Returns <boolean>

Gets a boolean indicating whether the button should be disabled.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether the button should be disabled.

• Returns <string>

Gets the id of the form that the button belongs to.

• formId <string>
• Throws <TypeError> if formId is not a valid <string>
• Returns <this>

Sets the id of the form that the button belongs to.

• Returns <string>

Gets where to send the form-data when a form is submitted, only for type="submit".

• action <string>
• Throws <TypeError> if action is not a valid <string>
• Returns <this>

Sets where to send the form-data when a form is submitted, only for type="submit".

• Returns <string>

Gets how the form-data should be encoded before sending it to a server, only for type="submit".

• enctype <string>
• Throws <TypeError> if enctype is not a valid <string>
• Returns <this>

Sets how the form-data should be encoded before sending it to a server, only for type="submit".

• Returns <string>

Gets the HTTP method used to send the data, only for type="submit".

• method <string>
• Throws <TypeError> if method is not a valid <string>
• Returns <this>

Sets the HTTP method used to send the data, only for type="submit".

• Returns <boolean>

Gets a boolean indicating whether the form-data should not be validated on submission, only for type="submit".

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether the form-data should not be validated on submission, only for type="submit".

• Returns <string>

Gets where to display the response after submitting the form, only for type="submit".

• target <string>
• Throws <TypeError> if target is not a valid <string>
• Returns <this>

Sets where to display the response after submitting the form, only for type="submit".

• Returns <number>

Gets the height of the input in pixels, only if input is of type image.

• pixels <number>
• Throws <TypeError> if pixels is not a valid <number>
• Returns <this>

Sets the height of the input in pixels, only if input is of type image.

• Returns <string>

Gets the id of a <DataList> element that contains pre-defined options for this input.

• list <string>
• Throws <TypeError> if list is not a valid <string>
• Returns <this>

Sets the id of a <DataList> element that contains pre-defined options for this input.

• Returns <string>

Gets the maximum value for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string>
• Returns <this>

Sets the maximum value for ths input.

• Returns <string>

Gets the maximum length of characters allowed for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string>
• Returns <this>

Sets the maximum length of characters allowed for ths input.

• Returns <string>

Gets the minimum value for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string>
• Returns <this>

Sets the minimum value for ths input.

• Returns <boolean>

Gets a boolean indicating whether multiple values can be entered in this input.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether multiple values can be entered in this input.

• Returns <string>

Gets the name of this input.

• name <string>
• Throws <TypeError> if name is not a valid <string>
• Returns <this>

Sets the name of this input.

• Returns <string>

Gets a regular expression that this input's value is validated against.

• regex <string>
• Throws <TypeError> if regex is not a valid <string>
• Returns <this>

Sets a regular expression that this input's value is validated against.

• Returns <string>

Gets the placeholder value for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string>
• Returns <this>

Sets the placeholder value for ths input.

• Returns <boolean>

Gets a boolean indicating whether this input is read only.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this input is read only.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <boolean>

Gets a boolean indicating whether this input is required.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this input is required.

• Returns <number>

Gets the size of this input in characters.

• size <string>
• Throws <TypeError> if size is not a valid <string>
• Returns <this>

Sets the size of this input in characters.

• Returns <string>

Gets the URL of the image to use as a submit button (only for input type image).

• url <string>
• Throws <TypeError> if url is not a valid <string>
• Returns <this>

Sets the URL of the image to use as a submit button (only for input type image).

• Returns <number>

Gets the step value for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string>
• Returns <this>

Sets the step value for ths input.

• Returns <string>

Gets the input type.

• flag <string>
• Throws <TypeError> if flag is not a valid <string>
• Returns <this>

Sets the input type.

• Returns <string>

Gets the initial value for ths input.

• value <string>
• Throws <TypeError> if value is not a valid <string> or <number>
• Returns <this>

Sets the initial value for ths input.

• Returns <number>

Gets the width of the input in pixels, only if input is of type image.

• pixels <number>
• Throws <TypeError> if pixels is not a valid <number>
• Returns <this>

Sets the width of the input in pixels, only if input is of type image.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML inserted elements.

• data <Object>
• Returns <Inserted>

Returns a new <Inserted> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets a URL to a document that explains the reason why the text was inserted.

• url <string>
• Throws <TypeError> if url is not a valid <string>
• Returns <this>

Sets a URL to a document that explains the reason why the text was inserted.

• Returns <string>

Gets the date and time of when the text was inserted.

• datetime <string> Required format: YYYY-MM-DDThh:mm:ssTZD
• Throws <TypeError> if datetime is not a valid <string>
• Returns <this>

Sets the date and time of when the text was inserted.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML italic elements.

• data <Object>
• Returns <Italic>

Returns a new <Italic> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML keyboard elements.

• data <Object>
• Returns <Keyboard>

Returns a new <Keyboard> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML label elements.

• data <Object>
• Returns <Label>

Returns a new <Label> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the id of the input this label is for.

• elementId <string>
• Throws <TypeError> if elementId is not a valid <string>
• Returns <this>

Sets the id of the input this label is for.

• Returns <string>

Gets the id of the form that this label belongs to.

• formId <string>
• Throws <TypeError> if formId is not a valid <string>
• Returns <this>

Sets the id of the form that this label belongs to.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML legend elements.

• data <Object>
• Returns <Legend>

Returns a new <Legend> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML line break elements.

• data <Object>
• Returns <LineBreak>

Returns a new <LineBreak> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML link elements.

• data <Object>
• Returns <Link>

Returns a new <Link> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets whether to allow links from third-party sites that allow cross-origin access, can be anonymous or `use-credentials`.

• type <string>
• Throws <TypeError> if type is not a valid <string>
• Returns <this>

Sets whether to allow links from third-party sites that allow cross-origin access, can be anonymous or `use-credentials`.

• Returns <string>

Gets the URL of the linked document.

• url <string>
• Throws <TypeError> if url is not a valid <string>
• Returns <this>

Sets the URL of the linked document.

• Returns <string>

Gets the language of the linked document.

• lang <string>
• Throws <TypeError> if lang is not a valid <string>
• Returns <this>

Sets the language of the linked document.

• Returns <string>

Gets the media device that the linked document is optimized for.

• device <string>
• Throws <TypeError> if device is not a valid <string>
• Returns <this>

Sets the media device that the linked document is optimized for.

• Returns <string>

Gets the relationship between the current document and the linked document. This value is equired.

• relationship <string>
• Throws <TypeError> if relationship is not a valid <string>
• Returns <this>

Sets the relationship between the current document and the linked document. This value is equired.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <string>

Gets the size of the icon, only for rel icon.

• size <string>
• Throws <TypeError> if size is not a valid <string>
• Returns <this>

Sets the size of the icon, only for rel icon.

• Returns <string>

Gets the media type of the linked document.

• media <string>
• Throws <TypeError> if media is not a valid <string>
• Returns <this>

Sets the media type of the linked document.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML list item elements.

• data <Object>
• Returns <ListItem>

Returns a new <ListItem> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <number>

Gets the value of the list item number that will be incremented from here on, only for list items in <OrderedList> elements.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the value of the list item number that will be incremented from here on, only for list items in <OrderedList> elements.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML main elements.

• data <Object>
• Returns <Main>

Returns a new <Main> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML map elements.

• data <Object>
• Returns <MapElement>

Returns a new <MapElement> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the name of this map.

• name <string>
• Throws <TypeError> if name is not a valid <string>
• Returns <this>

Sets the name of this map.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML mark elements.

• data <Object>
• Returns <Mark>

Returns a new <Mark> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML meta elements.

• data <Object>
• Returns <Meta>

Returns a new <Meta> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the character encoding for the HTML document.

• encoding <string>
• Throws <TypeError> if encoding is not a valid <string>
• Returns <this>

Sets the character encoding for the HTML document.

• Returns <string>

Gets the value associated with the http-equiv or name attribute.

• content <string>
• Throws <TypeError> if content is not a valid <string>
• Returns <this>

Sets the value associated with the http-equiv or name attribute.

• Returns <string>

Gets the HTTP header representing the information/value of the content attribute, can be `content-type`, `default-style`, or refresh.

• header <string>
• Throws <TypeError> if header is not a valid <string>
• Returns <this>

Sets the HTTP header representing the information/value of the content attribute, can be `content-type`, `default-style`, or refresh.

• Returns <string>

Gets the name of the metadata.

• name <string>
• Throws <TypeError> if name is not a valid <string>
• Returns <this>

Sets the name of the metadata.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML meter elements.

• data <Object>
• Returns <Meter>

Returns a new <Meter> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the id of the form that this meter belongs to.

• formId <string>
• Throws <TypeError> if formId is not a valid <string>
• Returns <this>

Sets the id of the form that this meter belongs to.

• Returns <number>

Gets the range that is considered to be a high value.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the range that is considered to be a high value.

• Returns <number>

Gets the range that is considered to be a low value.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the range that is considered to be a low value.

• Returns <number>

Gets the maximum value of the range.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the maximum value of the range.

• Returns <number>

Gets the minimum value of the range.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the minimum value of the range.

• Returns <number>

Gets the optimal value for the gauge.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the optimal value for the gauge.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <number>

Gets the current value of the gauge.

• value <number>
• Throws <TypeError> if value is not a valid <number>
• Returns <this>

Sets the current value of the gauge.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML multimedia object elements.

• data <Object>
• Returns <MultimediaObject>

Returns a new <MultimediaObject> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets the URL of the resource to be used by the object.

• url <string>
• Throws <TypeError> if url is not a valid <string>
• Returns <this>

Sets the URL of the resource to be used by the object.

• Returns <string>

Gets the id of the form that this object belongs to.

• formId <string>
• Throws <TypeError> if formId is not a valid <string>
• Returns <this>

Sets the id of the form that this object belongs to.

• Returns <number>

Gets the height of the object in pixels.

• pixels <number>
• Throws <TypeError> if pixels is not a valid <number>
• Returns <this>

Sets the height of the object in pixels.

• Returns <string>

Gets the name of the object.

• name <string>
• Throws <TypeError> if name is not a valid <string>
• Returns <this>

Sets the name of the object.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <string>

Gets the media type of data specified in the data attribute.

• type <string>
• Throws <TypeError> if type is not a valid <string>
• Returns <this>

Sets the media type of data specified in the data attribute.

• Returns <string>

Gets the ID of a <Map> element that should be used as a client-side iamge map.

• map <string>
• Throws <TypeError> if map is not a valid <string>
• Returns <this>

Sets the ID of a <Map> element that should be used as a client-side iamge map.

• Returns <number>

Gets the width of the object in pixels.

• pixels <number>
• Throws <TypeError> if pixels is not a valid <number>
• Returns <this>

Sets the width of the object in pixels.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML nav elements.

• data <Object>
• Returns <Nav>

Returns a new <Nav> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML no-script elements.

• data <Object>
• Returns <NoScript>

Returns a new <NoScript> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML option group elements.

• data <Object>
• Returns <OptionGroup>

Returns a new <OptionGroup> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <boolean>

Gets a boolean indicating whether this group of options should be disabled.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this group of options should be disabled.

• Returns <string>

Gets the name of the option group, as shown to the user.

• text <string>
• Throws <TypeError> if text is not a valid <string>
• Returns <this>

Sets the name of the option group, as shown to the user.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML option elements.

• data <Object>
• Returns <Option>

Returns a new <Option> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <boolean>

Gets a boolean indicating whether this option should be disabled.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this option should be disabled.

• Returns <string>

Gets the name of the option, as shown to the user.

• text <string>
• Throws <TypeError> if text is not a valid <string>
• Returns <this>

Sets the name of the option, as shown to the user.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <boolean>

Gets a boolean indicating whether this option should be pre-selected when the page loads.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this option should be pre-selected when the page loads.

• Returns <string>

Gets the value of ths option.

• value <string>
• Throws <TypeError> if value is not a valid <string> or <number>
• Returns <this>

Sets the value of ths option.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML ordered list elements.

• data <Object>
• Returns <OrderedList>

Returns a new <OrderedList> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• indent <number>

Render this element with indent spaces of indentation before each line.

• Returns <boolean>

Gets a boolean indicating whether this list should have its order reversed.

• flag <boolean>
• Throws <TypeError> if flag is not a valid <boolean>
• Returns <this>

Sets a boolean indicating whether this list should have its order reversed.

• Returns <number>

Gets the starting value to use for the list.

• value <number>
• Throws <TypeError> if flag is not a valid <number>
• Returns <this>

Sets the starting value to use for the list.

• Returns <string>

Gets the type of marker to use in the list, can be 1, A, a, I, or i.

• type <string>
• Throws <TypeError> if type is not a valid <string>
• Returns <this>

Sets the type of marker to use in the list, can be 1, A, a, I, or i.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML output elements.

• data <Object>
• Returns <Output>

Returns a new <Output> instance, initializing with any key/value pairs provided in data with keys that match setter method names.

• Returns <string>

Gets a space delimited list of input ids that are used in computing this output.

• elementIds <string>
• Throws <TypeError> if elementIds is not a valid <string>
• Returns <this>

Sets a space delimited list of input ids that are used in computing this output.

• Returns <string>

Gets the id of the form that this output belongs to.

• formId <string>
• Throws <TypeError> if formId is not a valid <string>
• Returns <this>

Sets the id of the form that this output belongs to.

• Returns <string>

Gets the name of this output.

• name <string>
• Throws <TypeError> if name is not a valid <string>
• Returns <this>

Sets the name of this output.

• indent <number>

Render this element with indent spaces of indentation before each line.

Copyright © 2018 Rich Lowe
Written by: Rich Lowe

• <Object>

Class for rendering HTML elements using short-hand methods and auto-nesting.

• indent <number>

Render this page with indent spaces of indentation before each line.

• template <boolean>
• Returns <Page>

Returns a new <Page> instance, initializing with , , and tags already included unless false is passed to the constructor.

• nest <string>|<Array>
• Returns <Abbreviation>

Returns a new <Abbreviation> instance, nesting inside the most recent

page.abbreviation(nest) [top]