Skip to content

Commit

Permalink
add readme features
Browse files Browse the repository at this point in the history
  • Loading branch information
Haehnchen committed Feb 27, 2024
1 parent b13fe74 commit f8d1ee8
Showing 1 changed file with 83 additions and 4 deletions.
87 changes: 83 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
IntelliJ IDEA / PhpStorm Vue.js Toolbox Plugin
========================
# IntelliJ IDEA / PhpStorm Vue.js Toolbox Plugin

[![Build Status](https://github.com/Haehnchen/idea-vuejs-plugin/actions/workflows/gradle.yml/badge.svg?branch=master)](https://github.com/Haehnchen/idea-vuejs-plugin/actions/workflows/gradle.yml)
[![Version](http://phpstorm.espend.de/badge/23832/version)](https://plugins.jetbrains.com/plugin/23832)
Expand All @@ -13,7 +12,87 @@ IntelliJ IDEA / PhpStorm Vue.js Toolbox Plugin
| Documentation | https://espend.de/phpstorm/plugin/vuejs-toolbox |
| Changelog | [CHANGELOG](CHANGELOG.md) |

Install
---------------------
## Install

* Install the plugin by going to `Settings -> Plugins -> Browse repositories` and then search for `Vue.js Toolbox`.

## Component Usages

### Navigation to component usages

```vue
<-- ButtonCounter.vue -->
<template/>
```

#### Target

```vue
<-- AnotherFile.vue -->
<script>
import ButtonCounter from './ButtonCounter.vue'
</script>
<template>
<ButtonCounter />
<button-counter />
</template>
```

### Infile navigation via LineMarker

```vue
<template>
<ButtonCounter />
<button-counter />
</template>
```

#### Targets

```vue
<script setup>
import ButtonCounter from './ButtonCounter.vue'
</script>
```

```javascript
export default {
components: {
ButtonCounter
}
}
```

```javascript
@Component({
components: {
ButtonCounter,
},
})
export default {}
```

Entrypoint
---------------------

# Linemarker for vue.js targeting its creation

```javascript
import App from './App.vue'
const app = createApp(App)
```

```javascript
import Vue from 'vue'
import App from './App.vue'

const app = new Vue({
render: (createElement) => createElement(App)
});
```

```javascript
import App from './App.vue';
new App().$mount(el);
```

0 comments on commit f8d1ee8

Please sign in to comment.