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.

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

Jump to bottom

I have added support for new alignment types, added a update trigger call for alignment change, added display of current alignment in the visual editor #58

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

I have added support for new alignment types, added a update trigger call for alignment change, added display of current alignment in the visual editor #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15f0a05
Fix issue #57 Now alignment trigger block-changed event
sanchesfree Apr 11, 2023
5fc5030
Added the ability to align text to the right and full width
sanchesfree Apr 11, 2023
0552be1
Fix issue #47 The text alignment is now visible in the editor
sanchesfree Apr 11, 2023
2d7cbb7
Added information to the documentation about support of new alignment…
sanchesfree Apr 11, 2023
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ You can choose alignment for the quote. It takes no effect while editing, but sa

## Output data

| Field | Type | Description |
| --------- | -------- | -------------------- |
| text | `string` | quote's text |
| caption | `string` | caption or an author |
| alignment | `string` | `left` or `center` |
| Field | Type | Description |
| --------- | -------- |--------------------------------------|
| text | `string` | quote's text |
| caption | `string` | caption or an author |
| alignment | `string` | `left`, `right`, `center`, `justify` |


```json
Expand Down
16 changes: 16 additions & 0 deletions src/index.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,22 @@
margin-bottom: 10px;
}

.cdx-quote__text--left {
text-align: left;
}

.cdx-quote__text--center {
text-align: center;
}

.cdx-quote__text--right {
text-align: right;
}

.cdx-quote__text--justify {
text-align: justify;
}

.cdx-quote__caption {}

.cdx-quote [contentEditable=true][data-placeholder]::before{
Expand Down
34 changes: 27 additions & 7 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/
import './index.css';

import { IconAlignLeft, IconAlignCenter, IconQuote } from '@codexteam/icons';
import {IconAlignLeft, IconAlignCenter, IconQuote, IconAlignJustify, IconAlignRight} from '@codexteam/icons';

/**
* @class Quote
Expand All @@ -15,13 +15,13 @@ import { IconAlignLeft, IconAlignCenter, IconQuote } from '@codexteam/icons';
* @description Quote Tool`s input and output data
* @property {string} text - quote`s text
* @property {string} caption - quote`s caption
* @property {'center'|'left'} alignment - quote`s alignment
* @property {'center'|'left'|'right'|'justify'} alignment - quote`s alignment
*
* @typedef {object} QuoteConfig
* @description Quote Tool`s initial configuration
* @property {string} quotePlaceholder - placeholder to show in quote`s text input
* @property {string} captionPlaceholder - placeholder to show in quote`s caption input
* @property {'center'|'left'} defaultAlignment - alignment to use as default
* @property {'center'|'left'|'right'|'justify'} defaultAlignment - alignment to use as default
*
* @typedef {object} TunesMenuConfig
* @property {string} icon - menu item icon
Expand Down Expand Up @@ -98,12 +98,14 @@ export default class Quote {
* Allowed quote alignments
*
* @public
* @returns {{left: string, center: string}}
* @returns {{left: string, center: string, right: string, justify: string}}
*/
static get ALIGNMENTS() {
return {
left: 'left',
center: 'center',
right: 'right',
justify: 'justify',
};
}

Expand Down Expand Up @@ -141,13 +143,14 @@ export default class Quote {
/**
* Tool`s styles
*
* @returns {{baseClass: string, wrapper: string, quote: string, input: string, caption: string}}
* @returns {{baseClass: string, wrapper: string, text: string, textTune: string, input: string, caption: string}}
*/
get CSS() {
return {
baseClass: this.api.styles.block,
wrapper: 'cdx-quote',
text: 'cdx-quote__text',
textTune: 'cdx-quote__text--' + this.data.alignment,
input: this.api.styles.input,
caption: 'cdx-quote__caption',
};
Expand All @@ -168,6 +171,14 @@ export default class Quote {
name: 'center',
icon: IconAlignCenter,
},
{
name: 'right',
icon: IconAlignRight,
},
{
name: 'justify',
icon: IconAlignJustify,
},
];
}

Expand All @@ -180,10 +191,11 @@ export default class Quote {
* api - Editor.js API
* readOnly - read-only mode flag
*/
constructor({ data, config, api, readOnly }) {
constructor({ data, config, api, readOnly, block }) {
const { ALIGNMENTS, DEFAULT_ALIGNMENT } = Quote;

this.api = api;
this.blockAPI = block;
this.readOnly = readOnly;

this.quotePlaceholder = config.quotePlaceholder || Quote.DEFAULT_QUOTE_PLACEHOLDER;
Expand All @@ -205,7 +217,7 @@ export default class Quote {
*/
render() {
const container = this._make('blockquote', [this.CSS.baseClass, this.CSS.wrapper]);
const quote = this._make('div', [this.CSS.input, this.CSS.text], {
const quote = this._make('div', [this.CSS.input, this.CSS.text, this.CSS.textTune], {
contentEditable: !this.readOnly,
innerHTML: this.data.text,
});
Expand Down Expand Up @@ -281,7 +293,15 @@ export default class Quote {
* @private
*/
_toggleTune(tune) {
const text = this.blockAPI.holder.querySelector(`.${this.CSS.text}`);
text.classList.remove(this.CSS.textTune)

this.data.alignment = tune;

text.classList.add(this.CSS.textTune)

// Tell Editor to know that block was changed
this.blockAPI.dispatchChange()
}

/**
Expand Down