Git Product home page Git Product logo

tiptap-wikilink-extension's Introduction

WikiLink Extension for the TipTap Editor

Adds WikiLinks (e.g.,[[Related Document]]).

Usage

See the demo at /example for a quick introduction on how to use this package. There is currently no npmjs.org package published, but meanwhile, this extension can also be quickly installed from GitHub directly using npm. For example, it can be installed using gitpkg.now.sh using the command npm install 'https://gitpkg.now.sh/aarkue/tiptap-wikilink-extension/packages/tiptap-wikilink-extension?main' and then cding into the node_modules/... folder and running npm install and npm run build.

Options

  • onWikiLinkClick: Is executed when a WikLink is clicked on. Type: (id: string, name: string, event: MouseEvent) => any
  • renderSuggestionFunction: Should render the suggestions based on the input text inside the element element. This can be done with vanilla javascript or, e.g., react-dom. Type: (element: HTMLElement, text: string, editor: Editor, range: { from: number; to: number }) => any

Screenshots + Demo

Try out the demo directly online at https://aarkue.github.io/tiptap-wikilink-extension/!

2023-06-05_10-55

tiptap-wikilink-extension's People

Contributors

aarkue avatar

Stargazers

Nivrith avatar

Watchers

 avatar

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.