Code Monkey home page Code Monkey logo

content-editable's Introduction

Build Status npm version Coverage Status

<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.

Installation

npm i content-editable

Usage

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

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.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.

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.

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.

content-editable {
    white-space: pre;
}

Development

Run tests

npm test

Run static server in examples directory

npm start

content-editable's People

Contributors

dependabot-preview[bot] avatar dependabot[bot] avatar markcellus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

saidsl pat-jpnk

content-editable's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.