docs: add a inertia.js draft to the guide

This commit is contained in:
Hans Pagel 2021-01-25 11:49:09 +01:00
parent ba427fafaa
commit 2bfe2f009f
2 changed files with 124 additions and 0 deletions

View File

@ -0,0 +1,120 @@
# Inertia.js
## toc
TODO
## Introduction
The following guide describes how to integrate tiptap with your Vue CLI project. If youve got Vue CLI on your machine already, you can skip the first step.
## Requirements
* [Node](https://nodejs.org/en/download/) installed on your machine
* Experience with [Vue](https://vuejs.org/v2/guide/#Getting-Started)
## 1. Install Vue CLI (optional)
Vue CLI aims to be the standard tooling baseline for the Vue ecosystem, and helps to create new projects quickly. If youre working with Vue a lot, chances are you have this installed already. Just skip this step then.
Here is how you could install (or update) it:
```bash
# with npm
npm install -g @vue/cli
# with Yarn
yarn global add @vue/cli
```
From now on, the `vue` command is available globally. Test it with `vue --version`, this should output the current version.
## 2. Create a project (optional)
If you already have an existing Vue project, thats fine too. Just skip this step and proceed with the next step.
For the sake of this guide, lets start with a fresh Vue project called `tiptap-example`. The Vue CLI sets up everything we need, just select the default Vue 2 template.
```bash
# create a project
vue create tiptap-example
# change directory
cd tiptap-example
```
## 3. Install the dependencies
Okay, enough of the boring boilerplate work. Lets finally install tiptap! For the following example youll need `@tiptap/core` (the actual editor) and the `@tiptap/vue-starter-kit` which has everything to get started quickly, for example a few default extensions and a basic Vue component.
```bash
# install with npm
npm install @tiptap/core @tiptap/vue-starter-kit
# install with Yarn
yarn add @tiptap/core @tiptap/vue-starter-kit
```
If you followed step 1 and 2, you can now start your project with `npm run dev` or `yarn dev`, and open [http://localhost:8080/](http://localhost:3000/) in your favorite browser. This might be different, if youre working with an existing project.
## 4. Create a new component
To actually start using tiptap, youll need to add a new component to your app. Lets call it `Tiptap` and put the following example code in `components/Tiptap.vue`.
This is the fastest way to get tiptap up and running with Vue. It will give you a very basic version of tiptap, without any buttons. No worries, you will be able to add more functionality soon.
```html
<template>
<editor-content :editor="editor" />
</template>
<script>
import { Editor, EditorContent, defaultExtensions } from '@tiptap/vue-starter-kit'
export default {
components: {
EditorContent,
},
data() {
return {
editor: null,
}
},
mounted() {
this.editor = new Editor({
content: '<p>Im running tiptap with Vue.js. 🎉</p>',
extensions: defaultExtensions(),
})
},
beforeDestroy() {
this.editor.destroy()
},
}
</script>
```
## 5. Add it to your app
Now, lets replace the content of `src/App.vue` with the following example code to use our new `Tiptap` component in our app.
```html
<template>
<div id="app">
<tiptap />
</div>
</template>
<script>
import Tiptap from './components/Tiptap.vue'
export default {
name: 'App',
components: {
Tiptap
}
}
</script>
```
You should now see tiptap in your browser. Youve successfully set up tiptap! Time to give yourself a pat on the back. Lets start to configure your editor in the next step.
## 6. Use v-model (optional)
Youre probably used to bind your data with `v-model` in forms, thats also possible with tiptap. Here is a working example component, that you can integrate in your project:
<demo name="Guide/GettingStarted/VModel" />

View File

@ -50,6 +50,10 @@
- title: Nuxt.js - title: Nuxt.js
link: /guide/getting-started/nuxtjs link: /guide/getting-started/nuxtjs
skip: true skip: true
- title: Inertia.js
link: /guide/getting-started/intertiajs
type: draft
skip: true
- title: React - title: React
link: /guide/getting-started/react link: /guide/getting-started/react
type: draft type: draft