An HTML element that makes its content editable
npm install content-editable


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.
``bash`
npm i content-editable
`html`
Then, when clicking anywhere on the element, a text field will show allowing the user to change the text.
| 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. |
You can listen in on when the text field contents have changed.
`javascript`
const element = document.querySelector('content-editable');
element.addEventListener('edit', (e) => {
console.log(e.target.innerHTML); // the new value
console.log(e.target.previousInnerHTML); // old value
});
| 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.
An editing attribute is applied to the element when the text inside of the element is in focus. So youblue
can style based on this attribute. The following turns the element's background to when
it is being edited.
`css`
content-editable[editing] {
background-color: blue;
}
#### Formatting whitespace
If you would like for line breaks or any other formatting to be respected, just apply white-space css property.
`css`
content-editable {
white-space: pre;
}
Run tests
`bash`
npm test
Run static server in examples directory
`bash``
npm start