{"id":22120678,"url":"https://github.com/hmarzban/extension-hyperlink","last_synced_at":"2025-07-25T12:33:52.263Z","repository":{"id":181478562,"uuid":"666835552","full_name":"HMarzban/extension-hyperlink","owner":"HMarzban","description":"A powerful and customizable hyperlink extension for Tiptap Editor, offering enhanced functionality similar to Google Docs link plugin.","archived":false,"fork":false,"pushed_at":"2024-01-14T21:06:12.000Z","size":4973,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-01-15T01:13:49.171Z","etag":null,"topics":["docsplus","editor","extension","google-docs","hyperlinks","javascript","plugin","tiptap"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HMarzban.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-07-15T18:28:28.000Z","updated_at":"2023-12-11T09:55:16.000Z","dependencies_parsed_at":"2023-07-15T19:54:40.152Z","dependency_job_id":"db4ee8b3-a622-4931-811a-644a7237a332","html_url":"https://github.com/HMarzban/extension-hyperlink","commit_stats":null,"previous_names":["hmarzban/extension-hyperlink"],"tags_count":16,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMarzban%2Fextension-hyperlink","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMarzban%2Fextension-hyperlink/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMarzban%2Fextension-hyperlink/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMarzban%2Fextension-hyperlink/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HMarzban","download_url":"https://codeload.github.com/HMarzban/extension-hyperlink/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227577191,"owners_count":17788639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docsplus","editor","extension","google-docs","hyperlinks","javascript","plugin","tiptap"],"created_at":"2024-12-01T14:29:26.532Z","updated_at":"2024-12-01T14:29:27.110Z","avatar_url":"https://github.com/HMarzban.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hyperlink Extension for Tiptap Editor\n\n[![Version](https://img.shields.io/npm/v/@docs.plus/extension-hyperlink.svg?label=version)](https://www.npmjs.com/package/@docs.plus/extension-hyperlink)\n![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nHey there! We're excited to present a game-changing extension for your [Tiptap](https://tiptap.dev/) editor that supercharges your hyperlink game. You know the sleek, easy-to-use Google Docs link plugin? Yeah, we've taken some inspiration from there and brought it over to Tiptap, just for you. So, get ready to enjoy a seamless, user-friendly experience!\n\n## Exciting Features 💡\n\nHere's what you can do with our extension:\n\n- Editing your hyperlink text and URL is as easy as pie now! Just run these commands:\n\n```js\neditor.commands.editHyperLinkText('New Text')\neditor.commands.editHyperLinkHref('\u003chttps://new-url.com\u003e')\neditor.commands.editHyperlink({\n  newText: 'New Text',\n  newURL: '\u003chttps://new-url.com\u003e'\n})\n```\n\n- Customize your own hyperlink previews and set hyperlinks with modals. Get creative and design any UI for the extension, extend it, make it yours! To do this, use:\n\n  ```js\n  import { useEditor, EditorContent } from \"@tiptap/react\";\n  import {\n    Hyperlink,\n    previewHyperlinkModal,\n    setHyperlinkModal,\n  } from \"@docs.plus/extension-hyperlink\";\n\n  // Tiptap Editor, React.js\n  const editor = useEditor({\n    extensions: [\n      Hyperlink.configure({\n        hyperlinkOnPaste: false,\n        openOnClick: true,\n        modals: {\n          previewHyperlink: previewHyperlinkModal,\n          setHyperlink: setHyperlinkModal,\n        },\n      }),\n    ],\n  });\n  ```\n\n  \u003e Curious to know more? Check out the full documentation [here](https://github.com/HMarzban/extension-hyperlink/tree/main/packages/extension-hyperlink).\n\n## All About You: Headless UI 💁‍♀️\n\nWe designed the hyperlink extension as a headless UI. You're in the driver's seat here! This means you can build your own interface while using our back-end functions. If you want to keep your application's UI consistent, this is perfect for you.\n\n## Setting Up - Easy As 1, 2, 3! 🔧\n\nGetting the `hyperlink` extension up and running on your project is super simple. Follow these steps:\n\n1. Install the package:\n\n```bach\nnpm install @docs.plus/extension-hyperlink\n```\n\n2. Import the extension into your project:\n\n```bash\nimport { Hyperlink } from '@docs.plus/extension-hyperlink'\n```\n\n3. Add the extension to your Tiptap Editor:\n\n```js\neditor = new Editor({\n  // Other configurations\n\n  extensions: [\n    // Other extensions\n    Hyperlink,\n  ]\n});\n```\n\n\u003e You can find more detailed setup instructions [here](https://github.com/HMarzban/extension-hyperlink/tree/main/packages/extension-hyperlink).\n\n## Test Drive With Our Demo 🚗\n\nWant to take a spin with our Hyperlink extension? We have a \u003cu\u003e**Demo ready**\u003c/u\u003e for you:\n\n### Step 0: Clone the Repo\n\nFirst, clone the repo to your local machine:\n\n```bash\ngit clone https://github.com/HMarzban/extension-hyperlink.git\n```\n\n### Step 1: Get the Essentials\n\nBefore hitting the road, make sure your tank's full! Install the necessary dependencies with:\n\n```bash\nyarn install\n```\n\n### Step 2: Run the Demo\n\nWith everything in place, you're ready to go. Run the demo with:\n\n```bash\nyarn start\n```\n\nNow, you can explore all that our \u003cu\u003eHyperlink extension\u003c/u\u003e has to offer in a real-life setting. Enjoy the ride!\n\n### Gif Time! 🎉\n\n![hyperlin-demo](https://raw.githubusercontent.com/HMarzban/extension-hyperlink/main/packages/nextjs/public/hyperlink-demo.gif)\n\n## What's Next? 🚀\n\nIn our mission to make your life easier, we have some exciting features lined up:\n\n- Finding and selecting all links in the document.\n- Choosing a heading and setting it as an anchor to the text.\n- convert a title link to a chip (UI).\n- And much more on the way!\n\n## The Legal Bits 📜\n\nThis project is under the MIT license, which means you're free to use, modify, distribute, and even sell your modifications under the same terms.\n\n## Join Our Journey 🤝\n\nWe love hearing from our users. Your suggestions, your issues, your PRs - they're all welcome. So don't be shy, feel free to get in touch on GitHub.\n\nWe're grateful you chose our hyperlink extension. We hope it makes your Tiptap experience even better.\n\n### Making Your docs.plus Even Better 💼\n\nThis extension is primarily built for the [docs.plus](http://github.com/docs-plus/docs.plus) project, an open-source platform for real-time collaboration. With this tool, communities can share and organize information in a logical, hierarchical manner, just like they want it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmarzban%2Fextension-hyperlink","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmarzban%2Fextension-hyperlink","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmarzban%2Fextension-hyperlink/lists"}