Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a custom shortcuts example #5981

Merged
merged 3 commits into from
Jan 14, 2025
Merged

Conversation

nperez0111
Copy link

Changes Overview

This adds an example to the repo showing how to make a custom keyboard shortcut extension

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

Sorry, something went wrong.

Copy link

changeset-bot bot commented Jan 3, 2025

⚠️ No Changeset found

Latest commit: 28e459d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for tiptap-embed ready!

Name Link
🔨 Latest commit 28e459d
🔍 Latest deploy log https://app.netlify.com/sites/tiptap-embed/deploys/6781378c97189d00081bec71
😎 Deploy Preview https://deploy-preview-5981--tiptap-embed.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Jan 3, 2025

Open in Stackblitz

@tiptap/core

npm i https://pkg.pr.new/@tiptap/core@5981

@tiptap/extension-bold

npm i https://pkg.pr.new/@tiptap/extension-bold@5981

@tiptap/extension-blockquote

npm i https://pkg.pr.new/@tiptap/extension-blockquote@5981

@tiptap/extension-bubble-menu

npm i https://pkg.pr.new/@tiptap/extension-bubble-menu@5981

@tiptap/extension-bullet-list

npm i https://pkg.pr.new/@tiptap/extension-bullet-list@5981

@tiptap/extension-character-count

npm i https://pkg.pr.new/@tiptap/extension-character-count@5981

@tiptap/extension-code-block

npm i https://pkg.pr.new/@tiptap/extension-code-block@5981

@tiptap/extension-code

npm i https://pkg.pr.new/@tiptap/extension-code@5981

@tiptap/extension-code-block-lowlight

npm i https://pkg.pr.new/@tiptap/extension-code-block-lowlight@5981

@tiptap/extension-collaboration

npm i https://pkg.pr.new/@tiptap/extension-collaboration@5981

@tiptap/extension-collaboration-cursor

npm i https://pkg.pr.new/@tiptap/extension-collaboration-cursor@5981

@tiptap/extension-color

npm i https://pkg.pr.new/@tiptap/extension-color@5981

@tiptap/extension-document

npm i https://pkg.pr.new/@tiptap/extension-document@5981

@tiptap/extension-dropcursor

npm i https://pkg.pr.new/@tiptap/extension-dropcursor@5981

@tiptap/extension-floating-menu

npm i https://pkg.pr.new/@tiptap/extension-floating-menu@5981

@tiptap/extension-focus

npm i https://pkg.pr.new/@tiptap/extension-focus@5981

@tiptap/extension-font-family

npm i https://pkg.pr.new/@tiptap/extension-font-family@5981

@tiptap/extension-gapcursor

npm i https://pkg.pr.new/@tiptap/extension-gapcursor@5981

@tiptap/extension-hard-break

npm i https://pkg.pr.new/@tiptap/extension-hard-break@5981

@tiptap/extension-heading

npm i https://pkg.pr.new/@tiptap/extension-heading@5981

@tiptap/extension-highlight

npm i https://pkg.pr.new/@tiptap/extension-highlight@5981

@tiptap/extension-history

npm i https://pkg.pr.new/@tiptap/extension-history@5981

@tiptap/extension-horizontal-rule

npm i https://pkg.pr.new/@tiptap/extension-horizontal-rule@5981

@tiptap/extension-italic

npm i https://pkg.pr.new/@tiptap/extension-italic@5981

@tiptap/extension-link

npm i https://pkg.pr.new/@tiptap/extension-link@5981

@tiptap/extension-list-item

npm i https://pkg.pr.new/@tiptap/extension-list-item@5981

@tiptap/extension-list-keymap

npm i https://pkg.pr.new/@tiptap/extension-list-keymap@5981

@tiptap/extension-mention

npm i https://pkg.pr.new/@tiptap/extension-mention@5981

@tiptap/extension-ordered-list

npm i https://pkg.pr.new/@tiptap/extension-ordered-list@5981

@tiptap/extension-paragraph

npm i https://pkg.pr.new/@tiptap/extension-paragraph@5981

@tiptap/extension-placeholder

npm i https://pkg.pr.new/@tiptap/extension-placeholder@5981

@tiptap/extension-strike

npm i https://pkg.pr.new/@tiptap/extension-strike@5981

@tiptap/extension-superscript

npm i https://pkg.pr.new/@tiptap/extension-superscript@5981

@tiptap/extension-subscript

npm i https://pkg.pr.new/@tiptap/extension-subscript@5981

@tiptap/extension-table

npm i https://pkg.pr.new/@tiptap/extension-table@5981

@tiptap/extension-table-cell

npm i https://pkg.pr.new/@tiptap/extension-table-cell@5981

@tiptap/extension-table-header

npm i https://pkg.pr.new/@tiptap/extension-table-header@5981

@tiptap/extension-table-row

npm i https://pkg.pr.new/@tiptap/extension-table-row@5981

@tiptap/extension-task-item

npm i https://pkg.pr.new/@tiptap/extension-task-item@5981

@tiptap/extension-task-list

npm i https://pkg.pr.new/@tiptap/extension-task-list@5981

@tiptap/extension-text

npm i https://pkg.pr.new/@tiptap/extension-text@5981

@tiptap/extension-text-align

npm i https://pkg.pr.new/@tiptap/extension-text-align@5981

@tiptap/extension-text-style

npm i https://pkg.pr.new/@tiptap/extension-text-style@5981

@tiptap/extension-typography

npm i https://pkg.pr.new/@tiptap/extension-typography@5981

@tiptap/extension-image

npm i https://pkg.pr.new/@tiptap/extension-image@5981

@tiptap/extension-underline

npm i https://pkg.pr.new/@tiptap/extension-underline@5981

@tiptap/extension-youtube

npm i https://pkg.pr.new/@tiptap/extension-youtube@5981

@tiptap/html

npm i https://pkg.pr.new/@tiptap/html@5981

@tiptap/pm

npm i https://pkg.pr.new/@tiptap/pm@5981

@tiptap/react

npm i https://pkg.pr.new/@tiptap/react@5981

@tiptap/starter-kit

npm i https://pkg.pr.new/@tiptap/starter-kit@5981

@tiptap/suggestion

npm i https://pkg.pr.new/@tiptap/suggestion@5981

@tiptap/vue-2

npm i https://pkg.pr.new/@tiptap/vue-2@5981

@tiptap/vue-3

npm i https://pkg.pr.new/@tiptap/vue-3@5981

commit: 28e459d

@nperez0111 nperez0111 force-pushed the custom-shortcuts-example branch from edfcf38 to 54b3846 Compare January 10, 2025 14:48

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
@nperez0111 nperez0111 requested a review from bdbch January 10, 2025 15:12
@nperez0111 nperez0111 merged commit 839eb47 into develop Jan 14, 2025
15 checks passed
@nperez0111 nperez0111 deleted the custom-shortcuts-example branch January 16, 2025 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant