Editable Content
A custom element that makes its contents editable by changing itself into an text field, when a user clicks on it.
This library was created to support features missing in the contenteditable
property specification and to alleviate its inconsistent browser implementations.
Installation
npm i editable-content
Usage
Change Me
Then, when clicking anywhere on the element, a text field will show allowing the user to change the text.
API
Attributes
Attribute | Type | Default | Description |
---|---|---|---|
readonly |
Boolean |
false |
Whether the text should be editable or not. |
multiline |
Boolean |
false |
Whether pressing enter should create a newline. If this is set to true , pressing enter will update the value to the new one. |
Events
You can listen in on when the text field contents have changed.
const element = document;element;
Event | Type | Description |
---|---|---|
edit |
CustomEvent |
Fired with a custom event when the text value has been successfully changed to a new value. The event detail will include both a textContent field that contains the updated value and a previousTextContent field that contains the last-known value. |
Of course, all of the other events supported by any HTMLElement are still available.
Styling
An editing
attribute is applied to the element when the text inside of the element is in focus. So you
can style based on this attribute. The following turns the element's background to blue
when
it is being edited.
Formatting whitespace
If you would like for line breaks or any other formatting to be respected, just apply white-space
css property.