npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

notestamp

v1.2.3

Published

Made with create-react-library

Downloads

166

Readme

notestamp

Made with create-react-library

NPM JavaScript Style Guide

Description

A rich text editor React component that supports clickable stamps.

A stamp is automatically inserted at the start of a line when the Enter key is pressed. You can define an arbitrary state to be stored inside a stamp.

You may also define an action to be performed when a stamp is clicked.

A common use case of this component is to synchronize text to some form of media e.g. an audio file. See https://notestamp.com as an example.

Install

npm install notestamp

Usage

import React, { useRef } from 'react'

import { Notestamp } from 'notestamp'

const editorRef = useRef(null)

const setStampData = dateStampRequested => {
  return { label: 'three', value: 3 }
}

const printStampLabel = (label, value) => console.log(`Clicked stamp: ${label}`)

return (
    <Notestamp ref={editorRef}
        onStampInsert={setStampData}
        onStampClick={printStampLabel}
        borderSize='1px'
        borderColor='lightgray'
        borderStyle='solid'
        toolbarBackgroundColor='whitesmoke'
    />
)

Exposed handles

The following functions can be accessed using the ref.

  • getJsonContent(): Returns an array that represents the editor's content (stamps included) in JSON format.

  • getTextlContent(): Returns the editor's content as a string (stamps excluded).

  • setContent(newContent): Set the editor's content to a JSON value defined by the parameter newContent.

Props

  • onStampInsert: When the Enter key is pressed, this callback function executes with argument dateEnterKeyPressed: Date. The return value should be an object { label: String, value: Any } where value is the state you want the stamp to hold and label is the actual string to display inside the stamp. If value is set to null, stamp insertion is aborted.

  • onStampClick: A callback function that executes with arguments label: String and value: Any when a stamp is clicked. There is no return value.

  • placeholder: The editor displays a placeholder text by default, but you may override it by passing a string to this prop or disable it by passing false.

  • toolbarBackgroundColor: Sets the background color of the toolbar.

  • borderColor, borderSize, borderStyle: Sets the color, size and style of the border surrounding the editor as well as the line separating the toolbar from the text area.

Credits

This editor was built using Slate.

License

MIT © fortyoneplustwo