Skip to content

Latest commit

 

History

History
54 lines (42 loc) · 2.54 KB

API.md

File metadata and controls

54 lines (42 loc) · 2.54 KB

API Reference

Properties

Property Type Default Description
path String undefined Path to the data for the article on Simpla's API
value String '' HTML string of the content in Simpla-article
placeholder String 'Start writing...' Placeholder to show when element is editable and has no content
noTypographer Boolean false Whether to disable smart typography rules
editable Boolean false Whether the article is editable
readonly Boolean false Whether the article is able to become editable
active Boolean false Whether the article is currently being edited
loaded Boolean false Whether the article content has been loaded from Simpla

Properties can be set with JavaScript or as attributes on the element. camelCased properties are seralized to kebab-cased attributes.

<simpla-article path="/article" no-typographer></simpla-article>

<script>
  document.querySelector('simpla-article').editable = true;
</script>

Schema

Type: 'Article'

Data Type Description
value String HTML string of the rendered content in simpla-article 
{
  "path": "/article/path",
  "type": "Article",
  "data": {
    "value": "<h1>Simpla article</h1><p>Simpla article is a new element that lets you write longform, rich-media articles seamlessly inline.</p>"
  },
  "createdAt": "2017-04-16T09:58:56.276Z",
  "updatedAt": "2017-05-09T09:25:36.835Z"
}

Events

Event Properties Description
value-changed value{String} Fired when value property changes
editable-changed value{Boolean} Fired when editable property changes
active-changed value{Boolean} Fired when active property changes
loaded-changed value{Boolean} Fired when loaded property changes