πŸ“¦ directus / visual-editing

Visual editing library to enable in-place editing of your website’s frontend from within the Visual Editor in Directus

β˜… 45 stars β‘‚ 8 forks πŸ‘ 45 watching βš–οΈ MIT License
cmscontent-editingcontent-editing-experiencecontent-editordirectuseditingeditorfrontendfrontend-editingfrontend-editoriframein-placein-place-editingin-place-editorlive-editinglive-editoroverlayspreviewvisual-editingvisual-editor
πŸ“₯ Clone https://github.com/directus/visual-editing.git
HTTPS git clone https://github.com/directus/visual-editing.git
SSH git clone git@github.com:directus/visual-editing.git
CLI gh repo clone directus/visual-editing
AlexGaillard AlexGaillard v1.1.0 446f39b 8 months ago πŸ“ History
πŸ“‚ main View all commits β†’
πŸ“ .github
πŸ“ src
πŸ“ test-website
πŸ“„ .editorconfig
πŸ“„ .gitignore
πŸ“„ .npmrc
πŸ“„ .prettierignore
πŸ“„ .prettierrc.json
πŸ“„ eslint.config.js
πŸ“„ license
πŸ“„ package.json
πŸ“„ pnpm-lock.yaml
πŸ“„ readme.md
πŸ“„ tsconfig.json
πŸ“„ tsup.config.js
πŸ“„ README.md

Visual Editing Frontend Library by Directus

This library works together with a Directus instance to enable Visual Editing functionality from within the Visual Editor module in Directus Studio.

Web developers must make use of this library to ensure communication between their website’s HTML elements and their Directus instance. This is done through data attributes and helper functions built into the library and imported into your website.

Documentation

Documentation covering the setup and functionality for both the frontend library and the studio module can be found in the Directus documentation.

Test Website

A test website pre-configured to work with the Directus Visual Editor module is included in the library’s repository. This can be used for example purposes and to make it easy to set up an environment for testing or contributing.

For detailed instructions on setting up the test environment see the test website's readme.md.

License

This package is licensed under the MIT License. See the LICENSE file for more information.

Additional Resources