Bard JS updates#618

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.

Sign up for GitHub

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

Merged
jasonvarga merged 2 commits into from
Nov 24, 2021
Merged

Bard JS updates #618

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdbfd9f
update
jasonvarga Nov 23, 2021
f5bb4cb
use new button callback argument
jasonvarga Nov 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 69 additions & 15 deletions content/collections/extending-docs/bard.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
return [
mark(new MyExtension),
node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
constructor(options = {}) {
this.options = options
}

name() {
return 'myextension';
}
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
get schema() {
return {
...super.schema,
toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
}
}
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
{ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
{ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
const indexOfBold = _.findIndex(buttons, { command: 'bold' });

buttons.splice(indexOfBold + 1, 0, {
buttons.splice(indexOfBold + 1, 0, button({
name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
});
}));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Bard JS updates#618

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 2 commits into

from

Nov 24, 2021
 Merged


Bard JS updates
#618
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
fdbfd9f

update


jasonvarga Nov 23, 2021
f5bb4cb

use new button callback argument


jasonvarga Nov 24, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


84 changes: 69 additions & 15 deletions
content/collections/extending-docs/bard.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,14 +21,16 @@ In short, here's a quickstart of the things you should probably start with:

## Extensions

You may add your own TipTap extensions to Bard using the `extend` method. The callback may return a single extension, or an array of them.
### Adding New Extensions

You may add your own TipTap extensions to Bard using the `addExtension` method. (Previously `extend`.) The callback may return a single extension, or an array of them.

``` js
Statamic.$bard.extend(({ mark, node }) => mark(new MyExtension));
Statamic.$bard.addExtension(({ mark, node }) => mark(new MyExtension));
```

``` js
Statamic.$bard.extend(({ mark, node }) => {
Statamic.$bard.addExtension(({ mark, node }) => {
 return [
 mark(new MyExtension),
 node(new AnotherExtension)
Expand All@@ -38,13 +40,21 @@ Statamic.$bard.extend(({ mark, node }) => {

The classes you return should be wrapped using the provided helper functions (i.e. `mark` or `node` like in the example above).

### Classes
:::tip
If you want to _replace_ an existing extension, [read below](#replacing-existing-extensions).
:::

### Extension Classes

Your extension class should look like a TipTap extension ([see an example here](https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/marks/Bold.js))
except it should not extend another class, and you should use methods instead of getters.

``` js
export default class MyExtension {
 constructor(options = {}) {
 this.options = options
 }

 name() {
 return 'myextension';
 }
Expand All@@ -71,9 +81,41 @@ export default class MyExtension {
}
```

### Replacing Existing Extensions

If you'd like to replace a [native extension](https://github.com/ueberdosis/tiptap/tree/v1/packages/tiptap-extensions/src/nodes) (e.g. headings or paragraphs) you can use the `replaceExtension` method. It takes the `name` of the extension, and a callback that returns a single extension instance.

The callback will provide you with the existing extension instance.

```js
Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return node(new CustomHeadingExtension(extension.options));
})
```

If you are doing simple tweaks to an extension (e.g. adding tailwind classes to headings) you can use the native extension classes directly by importing them through `$bard.tiptap.extensions`. Then you don't need to author an entire class and use the `mark` or `node` helpers.

```js
const { Heading } = Statamic.$bard.tiptap.extensions;

class CustomHeading extends Heading {
 get schema() {
 return {
 ...super.schema,
 toDOM: node => [`h${node.attrs.level}`, { class: 'font-bold' }, 0],
 }
 }
}

Statamic.$bard.replaceExtension('heading', ({ mark, node, extension }) => {
 return new CustomHeadingExtension(extension.options);
})
```


### Marks and Nodes

The `extend` callback will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
The `addExtension` and `replaceExtension` callbacks will provide the `mark` and `node` functions to you. Use it to wrap your class, and under the hood it will convert it to an actual TipTap extension class
to be used by Bard.

Within your class, Statamic will provide commonly used functions along with the arguments you'd get in a TipTap extension. This prevents you from needing to
Expand All@@ -99,33 +141,45 @@ If you're providing a new mark or node and intend to use this Bard field on the

## Buttons

To add a button to the toolbar, use the `buttons` method. The callback may return a button object, or an array of them.
To add a button to the toolbar, provide a callback to the `buttons` method.

The callback will receive two arguments:
- `buttons` - an array of the existing buttons in the toolbar (more about that in a moment)
- `button` - a function that wraps your button objects

The callback may return a `button` object, or an array of them.

``` js
Statamic.$bard.buttons(() => {
 return { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' };
Statamic.$bard.buttons((buttons, button) => {
 return button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' });
});
```

``` js
Statamic.$bard.buttons(() => [
 { name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' },
 { name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' },
Statamic.$bard.buttons((buttons, button) => [
button({ name: 'bold', text: __('Bold'), command: 'bold', icon: 'bold' }),
button({ name: 'italic', text: __('Italic'), command: 'italic', icon: 'italic' }),
]);
```

Returning values to the button method will push them onto the end. If you need more control, you can manipulate the supplied buttons argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:
Returning values to the `buttons` method will push them onto the end. If you need more control, you can manipulate the supplied `buttons` argument, and then return nothing. For example, we'll add a button after wherever the existing bold button happens to be:

``` js
Statamic.$bard.buttons(buttons => {
Statamic.$bard.buttons((buttons, button) => {
 const indexOfBold = _.findIndex(buttons, { command: 'bold' });

 buttons.splice(indexOfBold + 1, 0, {
 buttons.splice(indexOfBold + 1, 0, button({
 name: 'italic', text: 'Italic', command: 'italic', icon: 'italic'
 });
 }));
});
```

:::tip
Using the `button()` method will make the button only appear if the Bard field has been configured to your your button.

If you'd like your button to appear on all Bard fields, regardless of whether it's been configured to use that button, you can just return an object. Don't wrap with `button()`.
:::

## TipTap API

In your extensions, you may need to use functions from the `tiptap` library. Rather than importing the library yourself and bloating your JS files, you may use methods through our API.
Expand Down