Skip to content
This repository has been archived by the owner on May 22, 2023. It is now read-only.

A LaxarJS widget that sanitizes and displays HTML content from a resource

License

Notifications You must be signed in to change notification settings

LaxarJS/laxar-html-display-widget

Repository files navigation

laxar-html-display-widget Build Status

Displays HTML content from a resource.

Content

Appearance

Illustration of the laxar-html-display-widget

A laxar-html-display-widget displaying a text with a headline received through a resource.

Usage

Installation

For installation instruction take a look at the LaxarJS documentation.

Configuration example

{
   "widget": "laxar-html-display-widget",
   "features": {
      "content": {
         "resource": "info",
         "attribute": "nonLocalized"
      }
   }
}

Use this configuration on a page to get a laxar-html-display-widget which shows the HTML-Content from the resource "info".

For full configuration options refer to the widget.json.

Features

1. Illustrated Content (content)

R1.1 The widget MUST allow a configuration of a resource with HTML content. It MUST act as a slave of the resource according to the master/slave pattern.

R1.2 The widget MUST allow a configuration of an attribute which refers to the HTML content in the resource.

R1.3 The resource MUST be interpreted as (possibly internationalized) HTML content.

2. Support of Internationalization (i18n)

R2.1 The widget MUST allow the configuration of a locale as described in the documentation to LaxarJS i18n. When displaying internationalized content, the widget MUST use the current language tag of the locale.

Integration

Patterns

The widget supports the following event patterns as specified by the LaxarJS Patterns document.

Resources

  • Resource: content.resource
    • Role: Slave
    • Access: Read/Write
    • Description: Provides the HTML content, which should be displayed.

References

The following sources are useful or necessary for the understanding of this document. The links refer to the latest version of the documentation. Refer to the bower.json for the specific version that is normative for this document.

About

A LaxarJS widget that sanitizes and displays HTML content from a resource

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published