Git Product home page Git Product logo

directus-extension-tiptap's Introduction

Tiptap for Directus

npm version npm downloads License

This is a Directus extension that provides the Tiptap editor as a rich text field type.

The StarterKit tiptap bundle is already included and the other tiptap extensions are available in the directus interface options.

Requirements

This extension requires Directus 9 or higher to be installed.

Installation

Add @bicou/directus-extension-tiptap dependency to your directus project.

# Using pnpm
pnpm add @bicou/directus-extension-tiptap
# Using yarn
yarn add @bicou/directus-extension-tiptap
# Using npm
npm install @bicou/directus-extension-tiptap

Usage

Field

When creating a field in Directus choose TipTap.

field creation

Choosing Type allows you to store your content as a JSON object or as a good old HTML string

  • JSON : the JSON object of the ProseMirror nodes
  • Text : the HTML content as string

Editor

When editing content items, the Tiptap WYSIWG editor will show up :

editor

Field data and display

By default, the data is shown as raw JSON :

json render

Edit the field to select Tiptap as display ...

display

... to render the text of the field in content browsing :

text render

License

This extension is released under the MIT license. See the LICENSE file for more details.

directus-extension-tiptap's People

Contributors

dependabot[bot] avatar gbicou avatar github-actions[bot] avatar renovate[bot] avatar semantic-release-bot 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  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  avatar

directus-extension-tiptap's Issues

Could not resolve dependency

Hi!

I'm running Directus 10.8.2 and I can not get this extension to install.

This is the error I'm getting when trying to install it:

npm ERR! code ERESOLVE
npm ERR! ERESOLVE could not resolve
npm ERR!
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/vue
npm ERR!   peer vue@"3.3.4" from @directus/[email protected]
npm ERR!   node_modules/@directus/composables
npm ERR!     @directus/composables@"10.1.6" from @directus/[email protected]
npm ERR!     node_modules/@directus/extensions-sdk
npm ERR!       @directus/extensions-sdk@"10.2.0" from @directus/[email protected]
npm ERR!       node_modules/@directus/api
npm ERR!         @directus/api@"14.1.2" from [email protected]
npm ERR!         node_modules/directus
npm ERR!   vue@"3.3.4" from @directus/[email protected]
npm ERR!   node_modules/@directus/extensions-sdk
npm ERR!     @directus/extensions-sdk@"10.2.0" from @directus/[email protected]
npm ERR!     node_modules/@directus/api
npm ERR!       @directus/api@"14.1.2" from [email protected]
npm ERR!       node_modules/directus
npm ERR!         directus@"10.8.2" from the root project
npm ERR!   5 more (@directus/types, @directus/utils, @vitejs/plugin-vue, ...)
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! @bicou/directus-extension-tiptap@"*" from the root project
npm ERR!
npm ERR! Conflicting peer dependency: [email protected]
npm ERR! node_modules/vue
npm ERR!   peer vue@"^3.3.8" from @bicou/[email protected]
npm ERR!   node_modules/@bicou/directus-extension-tiptap
npm ERR!     @bicou/directus-extension-tiptap@"*" from the root project

What am I doing wrong?

Cheers

Kamil

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


No npm token specified.

An npm token must be created and set in the NPM_TOKEN environment variable on your CI environment.

Please make sure to create an npm token and to set it in the NPM_TOKEN environment variable on your CI environment. The token must allow to publish to the registry https://registry.npmjs.org/.


Good luck with your project ✨

Your semantic-release bot 📦🚀

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.


Warning

Renovate failed to look up the following dependencies: Failed to look up npm package @tiptap-pro/extension-invisible-characters.

Files affected: package.json


Other Branches

These updates are pending. To force PRs open, click the checkbox below.

  • chore(deps): update dependency prettier to v3.1.1
  • chore(deps): update dependency vue to v3.3.11
  • fix(deps): update tiptap monorepo to v2.1.13 (@tiptap/core, @tiptap/extension-character-count, @tiptap/extension-focus, @tiptap/extension-highlight, @tiptap/extension-link, @tiptap/extension-placeholder, @tiptap/extension-subscript, @tiptap/extension-superscript, @tiptap/extension-table, @tiptap/extension-table-cell, @tiptap/extension-table-header, @tiptap/extension-table-row, @tiptap/extension-task-item, @tiptap/extension-task-list, @tiptap/extension-text-align, @tiptap/extension-typography, @tiptap/extension-underline, @tiptap/pm, @tiptap/starter-kit, @tiptap/vue-3)
  • chore(deps): update dependency @changesets/cli to v2.27.1
  • chore(deps): update dependency eslint to v8.55.0
  • chore(deps): update dependency eslint-plugin-vue to v9.19.2
  • chore(deps): update dependency rollup to v4.8.0
  • chore(deps): update dependency vue-i18n to v9.8.0

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/build.yml
  • actions/checkout v4
  • pnpm/action-setup v2
  • actions/setup-node v4
.github/workflows/release.yml
  • actions/checkout v4
  • pnpm/action-setup v2
  • actions/setup-node v4
  • changesets/action v1
npm
package.json
  • @tiptap/core ^2.1.12
  • @tiptap/extension-character-count ^2.1.12
  • @tiptap/extension-focus ^2.1.12
  • @tiptap/extension-highlight ^2.1.12
  • @tiptap/extension-link ^2.1.12
  • @tiptap/extension-placeholder ^2.1.12
  • @tiptap/extension-subscript ^2.1.12
  • @tiptap/extension-superscript ^2.1.12
  • @tiptap/extension-table ^2.1.12
  • @tiptap/extension-table-cell ^2.1.12
  • @tiptap/extension-table-header ^2.1.12
  • @tiptap/extension-table-row ^2.1.12
  • @tiptap/extension-task-item ^2.1.12
  • @tiptap/extension-task-list ^2.1.12
  • @tiptap/extension-text-align ^2.1.12
  • @tiptap/extension-typography ^2.1.12
  • @tiptap/extension-underline ^2.1.12
  • @tiptap/pm ^2.1.12
  • @tiptap/starter-kit ^2.1.12
  • @changesets/changelog-github ^0.5.0
  • @changesets/cli ^2.26.2
  • @directus/extensions-sdk ^10.2.0
  • @directus/schema ^11.0.0
  • @directus/types ^11.0.2
  • @rushstack/eslint-patch ^1.6.0
  • @tiptap/vue-3 ^2.1.12
  • @vue/eslint-config-prettier ^8.0.0
  • @vue/eslint-config-typescript ^12.0.0
  • @vue/tsconfig ^0.4.0
  • eslint ^8.54.0
  • eslint-plugin-vue ^9.18.1
  • prettier ^3.1.0
  • rollup ^4.4.1
  • rollup-plugin-node-externals ^6.1.2
  • sass ^1.69.5
  • typescript ~5.2.2
  • vue ^3.3.8
  • vue-i18n ^9.6.5
  • @tiptap-pro/extension-invisible-characters ^2.4.1
  • @directus/extensions-sdk ^10.2.0
  • vue ^3.3.8
  • vue-i18n ^9.6.5
  • pnpm 8.12.0
nvm
.nvmrc
  • node 20.10.0

  • Check this box to trigger a request for Renovate to run again on this repository

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.