Trix Embed

#### Take control over what external links and embedded media is permitted in the Trix editor via copy/paste

Table of Contents

- Setup
- Features
- Allow / Block Lists
- Template Overrides
- Basic Usage
- Allow Lists
- Block Lists
- Sponsors
- Developing
- Releasing
- License

Dependencies

- ActionText
- Stimulus
- Trix

Setup

``sh
bundle add trix_embed
yarn add trix-embed@$(bundle show trix_embed | ruby -ne 'puts $_.split(/-/).last')
`

`js
import Trix from 'trix'
import "@rails/actiontext"
import { Application, Controller } from '@hotwired/stimulus'
import TrixEmbed from 'trix-embed'

const application = Application.start()
TrixEmbed.initialize({ application, Controller, Trix })
`

Features

$3

Configure allow and/or block lists for external links and embedded media in your Trix editors.

__⚠︎ Block lists have precendence!__

- allowed link hosts
- blocked link hosts
- allowed media hosts
- blocked media hosts

_Note that you can also use wildcards * in any of lists._

$3

TODO: document...

Basic Usage

$3

- Allow everything

`html




data-controller="trix-embed"
data-trix-embed-allowed-link-hosts-value='["*"]'
data-trix-embed-allowed-media-hosts-value='["*"]'>




`

- Allow links to all hosts and allow media (images, videos, etc.) from the following hosts: vimeo.com, voomly.com, youtube.com

`html




data-controller="trix-embed"
data-trix-embed-allowed-link-hosts-value='["*"]'
data-trix-embed-allowed-media-hosts-value='["vimeo.com", "voomly.com", "youtube.com"]'>




`

$3

- Block everything

`html




data-controller="trix-embed"
data-trix-embed-block-link-hosts-value='["*"]'
data-trix-embed-block-media-hosts-value='["*"]'>




`

...or simply.

`html









`

- Block links to the following hosts: 4chan.org, 8chan.net, thepiratebay.org
and block media (images, videos, etc.) from the following hosts: deviantart.com, imgur.com, tumblr.com

`html




data-controller="trix-embed"
data-trix-embed-blocked-link-hosts-value='["4chan.org", "8chan.net", "thepiratebay.org"]'
data-trix-embed-blocked-media-hosts-value='["deviantart.com", "imgur.com", "tumblr.com"]'>




`

Sponsors

Proudly sponsored by

Developing

`sh
git clone https://github.com/hopsoft/trix_embed.git
cd trix_embed
bin/dev
`

Releasing

1. Run yarn and bundle to pick up the latest
1. Bump version number at lib/trix_embed/version.rb. Pre-release versions use .preN
1. Bump version number at package.json _(make sure it matches)_. Pre-release versions use -preN
1. Run yarn build - builds both the Ruby gem and the NPM package
1. Commit and push changes to GitHub
1. Run rake release
1. Run yarn publish --no-git-tag-version --access public --new-version X.X.X` _(use same version number)_
1. Create a new release on GitHub (here) and generate the changelog for the stable release for it

License

The gem is available as open source under the terms of the MIT License.