Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

editable-content

Package Overview
Dependencies
Maintainers
1
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

editable-content

An HTML element that makes its content editable

  • 3.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Build Status npm version Coverage Status

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

<script src="node_modules/editable-content/dist/editable-content.js"></script>
<editable-content>Change Me</editable-content>

Then, when clicking anywhere on the element, a text field will show allowing the user to change the text.

API

Attributes

AttributeTypeDefaultDescription
readonlyBooleanfalseWhether the text should be editable or not.
multilineBooleanfalseWhether 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.querySelector('editable-content');
element.addEventListener('edit', (e) => {
    console.log(e.target.innerHTML); // the new value
    console.log(e.target.previousInnerHTML); // old value
});
EventTypeDescription
editCustomEventFired 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.

editable-content[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.

editable-content {
    white-space: pre;
}

Keywords

FAQs

Package last updated on 05 Jan 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc