mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2024-11-29 08:19:34 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/ueberdosis/tiptap-next into main

Browse Source
This commit is contained in:
Philipp Kühn 2020-09-11 16:32:24 +02:00
commit 5d3a2e900b
23 changed files with 570 additions and 472 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
.github/workflows/main.yml vendored
View File

@ -6,6 +6,9 @@ jobs:
test:
runs-on: ubuntu-latest
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
strategy:
matrix:
node-version: [14]
@ -20,6 +23,7 @@ jobs:
- uses: actions/checkout@v2.3.2
- name: Run tests with Cypress
id: cypress
uses: cypress-io/github-action@v2
with:
cache-key: node-v${{ matrix.node }}-on-${{ runner.os }}-hash-${{ hashFiles('yarn.lock') }}
@ -42,9 +46,22 @@ jobs:
name: cypress-videos
path: tests/cypress/videos
- name: Send Slack notifications
uses: act10ns/slack@v1
with:
status: ${{ job.status }}
steps: ${{ toJson(steps) }}
channel: '#tiptap-next'
if: failure()
build:
runs-on: ubuntu-latest
needs: test
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
strategy:
matrix:
node-version: [14]
@ -59,7 +76,17 @@ jobs:
- uses: actions/checkout@v2.3.2
- name: Install dependencies
id: install-dependencies
run: yarn install
- name: Build packages dependencies
id: build-packages
run: yarn build:packages
- name: Send Slack notifications
uses: act10ns/slack@v1
with:
status: ${{ job.status }}
steps: ${{ toJson(steps) }}
channel: '#tiptap-next'
if: failure()

111
docs/src/demos/Examples/Basic/index.spec.js
View File

@ -1,85 +1,82 @@
context('/examples/basic', () => {
beforeEach(() => {
before(() => {
cy.visit('/examples/basic')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>foo</p>')
done()
})
})
describe('export', () => {
it('should return html', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
it('should return html', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
expect(html).to.equal('<p>foo</p>')
})
expect(html).to.equal('<p>foo</p>')
})
})
it('should return json', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const json = editor.json()
it('should return json', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const json = editor.json()
expect(json).to.deep.equal({
type: 'document',
content: [
{
type: 'paragraph',
content: [
{
type: 'text',
text: 'foo'
}
]
}
]
})
expect(json).to.deep.equal({
type: 'document',
content: [
{
type: 'paragraph',
content: [
{
type: 'text',
text: 'foo'
}
]
}
]
})
})
})
describe('insertText', () => {
it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus(1).insertText('bar')
cy.get('.ProseMirror p:first').should('contain', 'barfoo')
})
})
it('should append', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('end').insertText('bar')
cy.get('.ProseMirror p:first').should('contain', 'foobar')
})
editor.focus(1).insertText('bar')
cy.get('.ProseMirror p:first').should('contain', 'barfoo')
})
})
describe('insertHTML', () => {
it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
it('should append', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('start').insertHTML('<p>bar</p>')
cy.get('.ProseMirror p:first').should('contain', 'bar').should('not.contain', 'foo')
cy.get('.ProseMirror p:last').should('contain', 'foo').should('not.contain', 'bar')
})
editor.focus('end').insertText('bar')
cy.get('.ProseMirror p:first').should('contain', 'foobar')
})
})
it('should append', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
it('should prepend', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('end').insertHTML('<p>bar</p>')
cy.get('.ProseMirror p:first').should('contain', 'foo').should('not.contain', 'bar')
cy.get('.ProseMirror p:last').should('contain', 'bar').should('not.contain', 'foo')
})
editor.focus('start').insertHTML('<p>bar</p>')
cy.get('.ProseMirror p:first').should('contain', 'bar').should('not.contain', 'foo')
cy.get('.ProseMirror p:last').should('contain', 'foo').should('not.contain', 'bar')
})
})
it('should append', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('end').insertHTML('<p>bar</p>')
cy.get('.ProseMirror p:first').should('contain', 'foo').should('not.contain', 'bar')
cy.get('.ProseMirror p:last').should('contain', 'bar').should('not.contain', 'foo')
})
})
})

106
docs/src/demos/Examples/ExportHtmlOrJson/index.spec.js
View File

@ -3,62 +3,60 @@ context('/examples/export-html-or-json', () => {
cy.visit('/examples/export-html-or-json')
})
describe('export', () => {
it('should return json', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const json = editor.json()
it('should return json', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const json = editor.json()
expect(json).to.deep.equal({
'type': 'document',
'content': [
{
'type': 'paragraph',
'content': [
{
'type': 'text',
'text': 'You are able to export your data as '
},
{
'type': 'text',
'marks': [
{
'type': 'code'
}
],
'text': 'HTML'
},
{
'type': 'text',
'text': ' or '
},
{
'type': 'text',
'marks': [
{
'type': 'code'
}
],
'text': 'JSON'
},
{
'type': 'text',
'text': '.'
}
]
}
]
})
})
})
it('should return html', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
expect(html).to.equal('<p>You are able to export your data as <code>HTML</code> or <code>JSON</code>.</p>')
expect(json).to.deep.equal({
'type': 'document',
'content': [
{
'type': 'paragraph',
'content': [
{
'type': 'text',
'text': 'You are able to export your data as '
},
{
'type': 'text',
'marks': [
{
'type': 'code'
}
],
'text': 'HTML'
},
{
'type': 'text',
'text': ' or '
},
{
'type': 'text',
'marks': [
{
'type': 'code'
}
],
'text': 'JSON'
},
{
'type': 'text',
'text': '.'
}
]
}
]
})
})
})
it('should return html', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
expect(html).to.equal('<p>You are able to export your data as <code>HTML</code> or <code>JSON</code>.</p>')
})
})
})

14
docs/src/demos/Examples/Focus/index.spec.js
View File

@ -1,16 +1,14 @@
context('/examples/focus', () => {
beforeEach(() => {
before(() => {
cy.visit('/examples/focus')
})
describe('focus class', () => {
it('should have class', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('start')
it('should have class', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.focus('start')
cy.get('.ProseMirror p:first').should('have.class', 'has-focus')
})
cy.get('.ProseMirror p:first').should('have.class', 'has-focus')
})
})
})

40
docs/src/demos/Examples/History/index.spec.js
View File

@ -3,34 +3,32 @@ context('/examples/history', () => {
cy.visit('/examples/history')
})
describe('undo', () => {
it('should not have a mistake', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
it('should not have a mistake', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake')
})
cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake')
})
})
it('should have a mistake', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
it('should have a mistake', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
editor.insertText('Mistake')
cy.get('.ProseMirror h2:first').should('contain', 'Mistake')
})
editor.insertText('Mistake')
cy.get('.ProseMirror h2:first').should('contain', 'Mistake')
})
})
it('the mistake should be removed again', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
it('the mistake should be removed again', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
const html = editor.html()
editor.undo()
cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake')
})
editor.undo()
cy.get('.ProseMirror h2:first').should('not.contain', 'Mistake')
})
})
})

149
docs/src/demos/Examples/MarkdownShortcuts/index.spec.js
View File

@ -1,100 +1,91 @@
context('/examples/markdown-shortcuts', () => {
beforeEach(() => {
before(() => {
cy.visit('/examples/markdown-shortcuts')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
done()
})
})
describe('headlines', () => {
it('should make a h1', () => {
cy.get('.ProseMirror')
.type('# Headline', {force: true})
.contains('h1', 'Headline')
})
it('should make a h2', () => {
cy.get('.ProseMirror')
.type('## Headline', {force: true})
.contains('h2', 'Headline')
})
it('should make a h3', () => {
cy.get('.ProseMirror')
.type('### Headline', {force: true})
.contains('h3', 'Headline')
})
it('should make a h4', () => {
cy.get('.ProseMirror')
.type('#### Headline', {force: true})
.contains('h4', 'Headline')
})
it('should make a h5', () => {
cy.get('.ProseMirror')
.type('##### Headline', {force: true})
.contains('h5', 'Headline')
})
it('should make a h6', () => {
cy.get('.ProseMirror')
.type('###### Headline', {force: true})
.contains('h6', 'Headline')
})
it('should make a h1', () => {
cy.get('.ProseMirror')
.type('# Headline', { force: true })
.contains('h1', 'Headline')
})
describe('code', () => {
it('should create inline code', () => {
cy.get('.ProseMirror')
.type('`$foobar`', {force: true})
.contains('code', '$foobar')
})
it('should make a h2', () => {
cy.get('.ProseMirror')
.type('## Headline', { force: true })
.contains('h2', 'Headline')
})
describe('code block', () => {
it.skip('should create a code block without language', () => {
cy.get('.ProseMirror')
.type('``` {enter}const foo = bar{enter}```', {force: true})
.contains('pre', 'const foo = bar')
})
it('should make a h3', () => {
cy.get('.ProseMirror')
.type('### Headline', { force: true })
.contains('h3', 'Headline')
})
describe('bullet list', () => {
it.skip('should create a bullet list from asteriks', () => {
cy.get('.ProseMirror')
.type('* foobar', {force: true})
.contains('ul', 'foobar')
})
it.skip('should create a bullet list from dashes', () => {
cy.get('.ProseMirror')
.type('- foobar', {force: true})
.contains('ul', 'foobar')
})
it.skip('should create a bullet list from pluses', () => {
cy.get('.ProseMirror')
.type('+ foobar', {force: true})
.contains('ul', 'foobar')
})
it('should make a h4', () => {
cy.get('.ProseMirror')
.type('#### Headline', { force: true })
.contains('h4', 'Headline')
})
describe('ordered list', () => {
it.skip('should create a ordered list', () => {
cy.get('.ProseMirror')
.type('1. foobar', {force: true})
.contains('ol', 'foobar')
})
it('should make a h5', () => {
cy.get('.ProseMirror')
.type('##### Headline', { force: true })
.contains('h5', 'Headline')
})
describe('blockquote', () => {
it.skip('should create a blockquote', () => {
cy.get('.ProseMirror')
.type('> foobar', {force: true})
.contains('blockquote', 'foobar')
})
it('should make a h6', () => {
cy.get('.ProseMirror')
.type('###### Headline', { force: true })
.contains('h6', 'Headline')
})
it('should create inline code', () => {
cy.get('.ProseMirror')
.type('`$foobar`', { force: true })
.contains('code', '$foobar')
})
it.skip('should create a code block without language', () => {
cy.get('.ProseMirror')
.type('``` {enter}const foo = bar{enter}```', { force: true })
.contains('pre', 'const foo = bar')
})
it.skip('should create a bullet list from asteriks', () => {
cy.get('.ProseMirror')
.type('* foobar', { force: true })
.contains('ul', 'foobar')
})
it.skip('should create a bullet list from dashes', () => {
cy.get('.ProseMirror')
.type('- foobar', { force: true })
.contains('ul', 'foobar')
})
it.skip('should create a bullet list from pluses', () => {
cy.get('.ProseMirror')
.type('+ foobar', { force: true })
.contains('ul', 'foobar')
})
it.skip('should create a ordered list', () => {
cy.get('.ProseMirror')
.type('1. foobar', { force: true })
.contains('ol', 'foobar')
})
it.skip('should create a blockquote', () => {
cy.get('.ProseMirror')
.type('> foobar', { force: true })
.contains('blockquote', 'foobar')
})
})

28
docs/src/demos/Examples/ReadOnly/index.spec.js
View File

@ -3,27 +3,25 @@ context('/examples/read-only', () => {
cy.visit('/examples/read-only')
})
describe('editable', () => {
it.skip('should be read-only', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('#editable').uncheck()
it.skip('should be read-only', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('#editable').uncheck()
const { editor } = window
editor.insertText('Edited: ')
const { editor } = window
editor.insertText('Edited: ')
cy.get('.ProseMirror p:first').should('not.contain', 'Edited: ')
})
cy.get('.ProseMirror p:first').should('not.contain', 'Edited: ')
})
})
it.skip('should be editable', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('#editable').check()
it.skip('should be editable', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('#editable').check()
const { editor } = window
editor.insertText('Edited: ')
const { editor } = window
editor.insertText('Edited: ')
cy.get('.ProseMirror p:first').should('contain', 'Edited: ')
})
cy.get('.ProseMirror p:first').should('contain', 'Edited: ')
})
})
})

2
docs/src/demos/Examples/Simple/index.spec.js
View File

@ -1,5 +1,5 @@
context('/examples/simple', () => {
beforeEach(() => {
before(() => {
cy.visit('/examples/simple')
})
})

67
docs/src/demos/Extensions/Blockquote/index.spec.js
View File

@ -1,48 +1,51 @@
context('/api/extensions/blockquote', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/blockquote')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('blockquote', () => {
it('the button should make the selected line a blockquote', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
})
it('the button should make the selected line a blockquote', () => {
cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
})
it('the button should toggle the blockquote', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror blockquote').should('not.exist')
})
it('the button should toggle the blockquote', () => {
cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
it('the keyboard shortcut should make the selected line a blockquote', () => {
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true})
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror blockquote').should('not.exist')
})
it('the keyboard shortcut should toggle the blockquote', () => {
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true})
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
cy.get('.ProseMirror').type('{meta}{shift}9', {force: true})
cy.get('.ProseMirror blockquote').should('not.exist')
})
it('the keyboard shortcut should make the selected line a blockquote', () => {
cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
})
it('should make a blockquote from markdown shortcuts', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
it('the keyboard shortcut should toggle the blockquote', () => {
cy.get('.ProseMirror blockquote').should('not.exist')
cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror').contains('blockquote', 'Example Text')
cy.get('.ProseMirror')
.type('> Quote', {force: true})
.contains('blockquote', 'Quote')
})
})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.ProseMirror').type('{meta}{shift}9', { force: true })
cy.get('.ProseMirror blockquote').should('not.exist')
})
it('should make a blockquote from markdown shortcuts', () => {
cy.get('.ProseMirror')
.type('> Quote', { force: true })
.contains('blockquote', 'Quote')
})
})

67
docs/src/demos/Extensions/Bold/index.spec.js
View File

@ -1,45 +1,54 @@
context('/api/extensions/bold', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/bold')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('bold', () => {
it('the button should make the selected text bold', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('strong', 'Example Text')
})
it('the button should make the selected text bold', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('strong', 'Example Text')
})
it('the button should toggle the selected text bold', () => {
cy.get('.demo__preview button:first').dblclick({ force: true })
cy.get('.ProseMirror strong').should('not.exist')
})
it('the button should toggle the selected text bold', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror strong').should('not.exist')
})
it('the keyboard shortcut should make the selected text bold', () => {
cy.get('.ProseMirror').type('{meta}b', {force: true})
cy.get('.ProseMirror').contains('strong', 'Example Text')
})
it('the keyboard shortcut should make the selected text bold', () => {
cy.get('.ProseMirror')
.type('{meta}b', { force: true })
.contains('strong', 'Example Text')
})
it('the keyboard shortcut should toggle the selected text bold', () => {
cy.get('.ProseMirror').type('{meta}b', {force: true}).type('{meta}b', {force: true})
cy.get('.ProseMirror strong').should('not.exist')
})
it('the keyboard shortcut should toggle the selected text bold', () => {
cy.get('.ProseMirror')
.type('{meta}b', { force: true })
.contains('strong', 'Example Text')
it('should make a bold text from the default markdown shortcut', () => {
cy.get('.ProseMirror')
.type('**Bold**', {force: true})
.contains('strong', 'Bold')
})
cy.get('.ProseMirror')
.type('{meta}b', { force: true })
.should('not.exist')
})
it('should make a bold text from the alternative markdown shortcut', () => {
cy.get('.ProseMirror')
.type('__Bold__', {force: true})
.contains('strong', 'Bold')
})
it('should make a bold text from the default markdown shortcut', () => {
cy.get('.ProseMirror')
.type('**Bold**', { force: true })
.contains('strong', 'Bold')
})
it('should make a bold text from the alternative markdown shortcut', () => {
cy.get('.ProseMirror')
.type('__Bold__', { force: true })
.contains('strong', 'Bold')
})
})

25
docs/src/demos/Extensions/Code/index.spec.js
View File

@ -1,23 +1,26 @@
context('/api/extensions/code', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/code')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('code', () => {
it('should mark the selected text as inline code', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('code', 'Example Text')
})
it('should mark the selected text as inline code', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('code', 'Example Text')
})
it('should toggle the selected text as inline code', () => {
cy.get('.demo__preview button:first').dblclick({ force: true })
cy.get('.ProseMirror code').should('not.exist')
})
it('should toggle the selected text as inline code', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror code').should('not.exist')
})
})

64
docs/src/demos/Extensions/CodeBlock/index.spec.js
View File

@ -1,48 +1,48 @@
context('/api/extensions/code-block', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/code-block')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('code-block', () => {
it('the button should make the selected line a code block', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
})
it('the button should make the selected line a code block', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
})
it('the button should toggle the code block', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror pre').should('not.exist')
})
it('the button should toggle the code block', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
it('the keyboard shortcut should make the selected line a code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true})
cy.get('.ProseMirror').contains('pre', 'Example Text')
})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror pre').should('not.exist')
})
it('the keyboard shortcut should toggle the code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true})
cy.get('.ProseMirror').contains('pre', 'Example Text')
cy.get('.ProseMirror').type('{control}{shift}\\', {force: true})
cy.get('.ProseMirror pre').should('not.exist')
})
it('the keyboard shortcut should make the selected line a code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
})
it('should make a code block from markdown shortcuts', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
it('the keyboard shortcut should toggle the code block', () => {
cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror').contains('pre', 'Example Text')
cy.get('.ProseMirror')
.type('``` {enter}Code', {force: true})
.contains('pre', 'Code')
})
})
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.ProseMirror').type('{control}{shift}\\', { force: true })
cy.get('.ProseMirror pre').should('not.exist')
})
it('should make a code block from markdown shortcuts', () => {
cy.get('.ProseMirror')
.type('``` {enter}Code', { force: true })
.contains('pre', 'Code')
})
})

2
docs/src/demos/Extensions/Document/index.spec.js
View File

@ -1,5 +1,5 @@
context('/api/extensions/document', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/document')
})
})

34
docs/src/demos/Extensions/HardBreak/index.spec.js
View File

@ -1,30 +1,30 @@
context('/api/extensions/hard-break', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/hard-break')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
})
})
describe('hard-break', () => {
it('the button should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror br').should('exist')
})
it('the button should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror br').should('exist')
})
it('the default keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{shift}{enter}', {force: true})
cy.get('.ProseMirror br').should('exist')
})
it('the default keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{shift}{enter}', { force: true })
cy.get('.ProseMirror br').should('exist')
})
it('the alternative keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{meta}{enter}', {force: true})
cy.get('.ProseMirror br').should('exist')
})
it('the alternative keyboard shortcut should add a line break', () => {
cy.get('.ProseMirror br').should('not.exist')
cy.get('.ProseMirror').type('{meta}{enter}', { force: true })
cy.get('.ProseMirror br').should('exist')
})
})

29
docs/src/demos/Extensions/Heading/index.spec.js
View File

@ -1,5 +1,32 @@
context('/api/extensions/heading', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/heading')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.selectAll()
done()
})
})
it('the button should make the selected line a h1', () => {
cy.get('.ProseMirror h1').should('not.exist')
cy.get('.demo__preview button:nth-child(1)').click({ force: true })
cy.get('.ProseMirror').contains('h1', 'Example Text')
})
it('the button should make the selected line a h2', () => {
cy.get('.ProseMirror h2').should('not.exist')
cy.get('.demo__preview button:nth-child(2)').click({ force: true })
cy.get('.ProseMirror').contains('h2', 'Example Text')
})
it('the button should make the selected line a h3', () => {
cy.get('.ProseMirror h3').should('not.exist')
cy.get('.demo__preview button:nth-child(3)').click({ force: true })
cy.get('.ProseMirror').contains('h3', 'Example Text')
})
})

50
docs/src/demos/Extensions/History/index.spec.js
View File

@ -1,47 +1,45 @@
context('/api/extensions/history', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/history')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Mistake</p>')
})
})
describe('undo', () => {
it('should make the last change undone', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake')
it('should make the last change undone', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
})
})
it('the keyboard shortcut should make the last change undone', () => {
cy.get('.ProseMirror').type('{meta}z', {force: true})
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
})
})
describe('redo', () => {
it('should apply the last undone change again', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake')
it('the keyboard shortcut should make the last change undone', () => {
cy.get('.ProseMirror').type('{meta}z', { force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
})
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
cy.get('.demo__preview button:nth-child(2)').click({ force: true })
cy.get('.ProseMirror').should('contain', 'Mistake')
})
})
it('should apply the last undone change again', () => {
cy.get('.ProseMirror').window().then(window => {
cy.get('.ProseMirror').should('contain', 'Mistake')
it.skip('the keyboard shortcut should apply the last undone change again', () => {
cy.get('.ProseMirror').type('{meta}z', {force: true})
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
cy.get('.ProseMirror').type('{meta}{shift}z', {force: true})
cy.get('.demo__preview button:nth-child(2)').click({ force: true })
cy.get('.ProseMirror').should('contain', 'Mistake')
})
})
it.skip('the keyboard shortcut should apply the last undone change again', () => {
cy.get('.ProseMirror').type('{meta}z', { force: true })
cy.get('.ProseMirror').should('not.contain', 'Mistake')
cy.get('.ProseMirror').type('{meta}{shift}z', { force: true })
cy.get('.ProseMirror').should('contain', 'Mistake')
})
})

46
docs/src/demos/Extensions/HorizontalRule/index.spec.js
View File

@ -1,40 +1,40 @@
context('/api/extensions/horizontal-rule', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/horizontal-rule')
})
beforeEach(() => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
})
})
describe('horizontal-rule', () => {
it('the button should add a horizontal rule', () => {
it('the button should add a horizontal rule', () => {
cy.get('.ProseMirror hr').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror hr').should('exist')
})
it('the default markdown shortcut should add a horizontal rule', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
cy.get('.ProseMirror hr').should('not.exist')
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('---', { force: true })
cy.get('.ProseMirror hr').should('exist')
})
})
it('the default markdown shortcut should add a horizontal rule', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
it('the alternative markdown shortcut should add a horizontal rule', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
cy.get('.ProseMirror hr').should('not.exist')
cy.get('.ProseMirror').type('---', {force: true})
cy.get('.ProseMirror hr').should('exist')
})
})
it('the alternative markdown shortcut should add a horizontal rule', () => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
cy.get('.ProseMirror hr').should('not.exist')
cy.get('.ProseMirror').type('___ ', {force: true})
cy.get('.ProseMirror hr').should('exist')
})
cy.get('.ProseMirror hr').should('not.exist')
cy.get('.ProseMirror').type('___ ', { force: true })
cy.get('.ProseMirror hr').should('exist')
})
})
})

41
docs/src/demos/Extensions/Italic/index.spec.js
View File

@ -1,33 +1,36 @@
context('/api/extensions/italic', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/italic')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('italic', () => {
it('the button should make the selected text italic', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('em', 'Example Text')
})
it('the button should make the selected text italic', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('em', 'Example Text')
})
it('the button should toggle the selected text italic', () => {
cy.get('.demo__preview button:first').dblclick({ force: true })
cy.get('.ProseMirror em').should('not.exist')
})
it('the button should toggle the selected text italic', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror em').should('not.exist')
})
it('the keyboard shortcut should make the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', {force: true})
cy.get('.ProseMirror').contains('em', 'Example Text')
})
it('the keyboard shortcut should make the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', { force: true })
cy.get('.ProseMirror').contains('em', 'Example Text')
})
it('the keyboard shortcut should toggle the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', {force: true}).type('{meta}i', {force: true})
cy.get('.ProseMirror em').should('not.exist')
})
it('the keyboard shortcut should toggle the selected text italic', () => {
cy.get('.ProseMirror').type('{meta}i', { force: true }).type('{meta}i', { force: true })
cy.get('.ProseMirror em').should('not.exist')
})
})

30
docs/src/demos/Extensions/Paragraph/index.spec.js
View File

@ -1,5 +1,33 @@
context('/api/extensions/paragraph', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/paragraph')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.clearContent()
done()
})
})
it('text should be wrapped in a paragraph by default', () => {
cy.get('.ProseMirror').type('Example Text', { force: true })
cy.get('.ProseMirror').contains('p', 'Example Text')
cy.get('.ProseMirror').find('p').should('have.length', 1)
})
it('enter should make a new paragraph', () => {
cy.get('.ProseMirror').type('First Paragraph{enter}Second Paragraph', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 2)
cy.get('.ProseMirror').contains('p:first', 'First Paragraph')
cy.get('.ProseMirror').contains('p:nth-child(2)', 'Second Paragraph')
})
it('backspace should remove the second paragraph', () => {
cy.get('.ProseMirror').type('{enter}', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 2)
cy.get('.ProseMirror').type('{backspace}', { force: true })
cy.get('.ProseMirror').find('p').should('have.length', 1)
})
})

51
docs/src/demos/Extensions/Strike/index.spec.js
View File

@ -1,39 +1,42 @@
context('/api/extensions/strike', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/strike')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('strike', () => {
it('the button should strike the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('s', 'Example Text')
})
it('the button should strike the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('s', 'Example Text')
})
it('the button should toggle the selected text striked', () => {
cy.get('.demo__preview button:first').dblclick({ force: true })
cy.get('.ProseMirror s').should('not.exist')
})
it('the button should toggle the selected text striked', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror s').should('not.exist')
})
it('the keyboard shortcut should strike the selected text', () => {
cy.get('.ProseMirror').type('{meta}d', {force: true})
cy.get('.ProseMirror').contains('s', 'Example Text')
})
it('the keyboard shortcut should strike the selected text', () => {
cy.get('.ProseMirror').type('{meta}d', { force: true })
cy.get('.ProseMirror').contains('s', 'Example Text')
})
it('the keyboard shortcut should toggle the selected text striked', () => {
cy.get('.ProseMirror').type('{meta}d', {force: true}).type('{meta}d', {force: true})
cy.get('.ProseMirror s').should('not.exist')
})
it('the keyboard shortcut should toggle the selected text striked', () => {
cy.get('.ProseMirror').type('{meta}d', { force: true }).type('{meta}d', { force: true })
cy.get('.ProseMirror s').should('not.exist')
})
it('should make a striked text from the markdown shortcut', () => {
cy.get('.ProseMirror')
.type('~Strike~', {force: true})
.contains('s', 'Strike')
})
it('should make a striked text from the markdown shortcut', () => {
cy.get('.ProseMirror')
.type('~Strike~', { force: true })
.contains('s', 'Strike')
})
})

41
docs/src/demos/Extensions/Underline/index.spec.js
View File

@ -1,33 +1,36 @@
context('/api/extensions/underline', () => {
beforeEach(() => {
before(() => {
cy.visit('/api/extensions/underline')
})
beforeEach((done) => {
cy.get('.ProseMirror').window().then(window => {
const { editor } = window
editor.setContent('<p>Example Text</p>')
editor.focus().selectAll()
editor.selectAll()
done()
})
})
describe('bold', () => {
it('the button should underline the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('u', 'Example Text')
})
it('the button should underline the selected text', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').contains('u', 'Example Text')
})
it('the button should toggle the selected text underline', () => {
cy.get('.demo__preview button:first').dblclick({ force: true })
cy.get('.ProseMirror u').should('not.exist')
})
it('the button should toggle the selected text underline', () => {
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror').type('{selectall}', { force: true })
cy.get('.demo__preview button:first').click({ force: true })
cy.get('.ProseMirror u').should('not.exist')
})
it('the keyboard shortcut should underline the selected text', () => {
cy.get('.ProseMirror').type('{meta}u', {force: true})
cy.get('.ProseMirror').contains('u', 'Example Text')
})
it('the keyboard shortcut should underline the selected text', () => {
cy.get('.ProseMirror').type('{meta}u', { force: true })
cy.get('.ProseMirror').contains('u', 'Example Text')
})
it('the keyboard shortcut should toggle the selected text underline', () => {
cy.get('.ProseMirror').type('{meta}u', {force: true}).type('{meta}u', {force: true})
cy.get('.ProseMirror u').should('not.exist')
})
it('the keyboard shortcut should toggle the selected text underline', () => {
cy.get('.ProseMirror').type('{meta}u', { force: true }).type('{meta}u', { force: true })
cy.get('.ProseMirror u').should('not.exist')
})
})

14
docs/src/links.yaml
View File

@ -194,4 +194,16 @@
- title: getSchema
link: /api/schema/get-schema
- title: generateHtml
link: /api/schema/generate-html
link: /api/schema/generate-html
- title: Best Practices
items:
- title: Overview
link: /best-practices/overview/
draft: true
- title: Menus
link: /best-practices/menus/
draft: true
- title: Keyboard Shortcuts
link: /best-practices/keyboard-shortcuts/
draft: true

4
tests/cypress.json
View File

@ -1,5 +1,7 @@
{
"baseUrl": "http://localhost:3000",
"integrationFolder": "../docs/src/",
"testFiles": "**/*.spec.js"
"testFiles": "**/*.spec.js",
"viewportWidth": 1280,
"viewportHeight": 1280
}