mirror of
https://github.com/Ocelot-Social-Community/Ocelot-Social.git
synced 2026-01-14 17:04:38 +00:00
581 lines
18 KiB
HTML
581 lines
18 KiB
HTML
|
||
<!DOCTYPE HTML>
|
||
<html lang="" >
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
<title>Vue · Ocelot.Social – Developer Documentation</title>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
||
<meta name="description" content="">
|
||
<meta name="generator" content="GitBook 3.2.3">
|
||
<meta name="author" content="busFaktor() e.V.">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/style.css">
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-hints/plugin-hints.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-tabs2/tabs.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search-pro/search.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-splitter/splitter.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-chapter-fold/chapter-fold.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<meta name="HandheldFriendly" content="true"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
||
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
||
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
||
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
||
|
||
|
||
<link rel="next" href="../testing.html" />
|
||
|
||
|
||
<link rel="prev" href="scss.html" />
|
||
|
||
|
||
</head>
|
||
<body>
|
||
|
||
<div class="book">
|
||
<div class="book-summary">
|
||
|
||
|
||
<div id="book-search-input" role="search">
|
||
<input type="text" placeholder="Type to search" />
|
||
</div>
|
||
|
||
|
||
<nav role="navigation">
|
||
|
||
|
||
|
||
<ul class="summary">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="chapter " data-level="1.1" data-path="../">
|
||
|
||
<a href="../">
|
||
|
||
|
||
Introduction
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.2" data-path="../edit-this-documentation.html">
|
||
|
||
<a href="../edit-this-documentation.html">
|
||
|
||
|
||
Edit this Documentation
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.3" data-path="../neo4j/">
|
||
|
||
<a href="../neo4j/">
|
||
|
||
|
||
Neo4J
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.4" data-path="../backend/">
|
||
|
||
<a href="../backend/">
|
||
|
||
|
||
Backend
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.4.1" data-path="../backend/graphql.html">
|
||
|
||
<a href="../backend/graphql.html">
|
||
|
||
|
||
GraphQL
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.4.2" data-path="../backend/neo4j-graphql-js.html">
|
||
|
||
<a href="../backend/neo4j-graphql-js.html">
|
||
|
||
|
||
neo4j-graphql-js
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5" data-path="./">
|
||
|
||
<a href="./">
|
||
|
||
|
||
Webapp
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.5.1" data-path="components.html">
|
||
|
||
<a href="components.html">
|
||
|
||
|
||
Components
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5.2" data-path="html.html">
|
||
|
||
<a href="html.html">
|
||
|
||
|
||
HTML
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.5.3" data-path="scss.html">
|
||
|
||
<a href="scss.html">
|
||
|
||
|
||
SCSS
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter active" data-level="1.5.4" data-path="vue.html">
|
||
|
||
<a href="vue.html">
|
||
|
||
|
||
Vue
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6" data-path="../testing.html">
|
||
|
||
<a href="../testing.html">
|
||
|
||
|
||
Testing Guide
|
||
|
||
</a>
|
||
|
||
|
||
|
||
<ul class="articles">
|
||
|
||
|
||
<li class="chapter " data-level="1.6.1" data-path="../cypress/">
|
||
|
||
<a href="../cypress/">
|
||
|
||
|
||
End-to-end tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6.2" data-path="testing.html">
|
||
|
||
<a href="testing.html">
|
||
|
||
|
||
Frontend tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.6.3" data-path="../backend/testing.html">
|
||
|
||
<a href="../backend/testing.html">
|
||
|
||
|
||
Backend tests
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.7" data-path="../DOCKER_MORE_CLOSELY.html">
|
||
|
||
<a href="../DOCKER_MORE_CLOSELY.html">
|
||
|
||
|
||
Docker More Closely
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.8" >
|
||
|
||
<a target="_blank" href="https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/blob/master/deployment/README.md">
|
||
|
||
|
||
Deployment
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.9" data-path="../CONTRIBUTING.html">
|
||
|
||
<a href="../CONTRIBUTING.html">
|
||
|
||
|
||
Contributing
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.10" data-path="../cypress/features.html">
|
||
|
||
<a href="../cypress/features.html">
|
||
|
||
|
||
Feature Specification
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.11" data-path="../CODE_OF_CONDUCT.html">
|
||
|
||
<a href="../CODE_OF_CONDUCT.html">
|
||
|
||
|
||
Code of conduct
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
<li class="chapter " data-level="1.12" data-path="../LICENSE.html">
|
||
|
||
<a href="../LICENSE.html">
|
||
|
||
|
||
License
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
|
||
|
||
</nav>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="book-body">
|
||
|
||
<div class="body-inner">
|
||
|
||
|
||
|
||
<div class="book-header" role="navigation">
|
||
|
||
|
||
<!-- Title -->
|
||
<h1>
|
||
<i class="fa fa-circle-o-notch fa-spin"></i>
|
||
<a href=".." >Vue</a>
|
||
</h1>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="page-wrapper" tabindex="-1" role="main">
|
||
<div class="page-inner">
|
||
|
||
<div id="book-search-results">
|
||
<div class="search-noresults">
|
||
|
||
<section class="normal markdown-section">
|
||
|
||
<h1 id="vue-–-code-guidelines">Vue – Code Guidelines</h1>
|
||
<h2 id="we-use-single-file-components">We use single-file components</h2>
|
||
<p>Each component lives in a single file, containing:</p>
|
||
<ul>
|
||
<li>its <code>template</code> (the DOM structure)</li>
|
||
<li>its <code>script</code> (including <code>props</code>, <code>data</code> and <code>methods</code> among other things)</li>
|
||
<li>its <code>style</code> (defining the look of the component)</li>
|
||
</ul>
|
||
<p>See the <a href="https://vuejs.org/v2/guide/single-file-components.html" target="_blank">Vue.js docs</a> for more details.</p>
|
||
<p>Placed in the same folder are also:</p>
|
||
<ul>
|
||
<li>the test file (e.g. <code>MyComponent.spec.js</code>)</li>
|
||
<li>the storybook file (e.g. <code>MyComponent.story.js</code>)</li>
|
||
</ul>
|
||
<h2 id="we-use-typed-props">We use typed props</h2>
|
||
<p>Vue.js allows us to define component props either as strings or as objects (with <code>type</code> and <code>default</code> or <code>required</code> values). Always go for the second option!</p>
|
||
<p>Also: only (and always!) define a <code>default</code> for props that are <em>not required</em>.</p>
|
||
<p>Why?</p>
|
||
<ul>
|
||
<li>it makes our code more robust – a warning will be shown when passing a wrong prop type</li>
|
||
<li>it clearly defines the component API and tells other developers how to use it</li>
|
||
</ul>
|
||
<p>It is as easy as writing:</p>
|
||
<pre><code>props: {
|
||
title: {
|
||
type: String,
|
||
required: true,
|
||
},
|
||
image: {
|
||
type: String,
|
||
default: 'human-connection-logo.png',
|
||
},
|
||
}
|
||
</code></pre><p>For more complex use cases see the <a href="https://vuejs.org/v2/guide/components-props.html#Prop-Validation" target="_blank">official Vue.js documentation</a>.</p>
|
||
<h2 id="we-use-shorthands">We use shorthands</h2>
|
||
<p>For better readability we prefer</p>
|
||
<ul>
|
||
<li><code>:something</code> over <code>v-bind:something</code></li>
|
||
<li><code>@click</code> over <code>v-on:click</code></li>
|
||
<li><code>#slotSame</code> over <code>v-slot:slotName</code></li>
|
||
<li><code>#default</code> over <code>v-slot</code></li>
|
||
</ul>
|
||
<p>Read more in the <a href="https://vuejs.org/v2/guide/syntax.html#Shorthands" target="_blank">official Vue.js docs</a> (for <a href="https://vuejs.org/v2/guide/components-slots.html#Named-Slots-Shorthand" target="_blank">slots</a>)</p>
|
||
<h2 id="recommended-reads">Recommended reads</h2>
|
||
<p>The <a href="https://pablohpsilva.github.io/vuejs-component-style-guide/#/?id=harness-your-component-props" target="_blank">Vue.js component style guide</a> offers a whole list of best-practices for writing Vue components.</p>
|
||
|
||
|
||
</section>
|
||
|
||
</div>
|
||
<div class="search-results">
|
||
<div class="has-results">
|
||
|
||
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
||
<ul class="search-results-list"></ul>
|
||
|
||
</div>
|
||
<div class="no-results">
|
||
|
||
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<a href="scss.html" class="navigation navigation-prev " aria-label="Previous page: SCSS">
|
||
<i class="fa fa-angle-left"></i>
|
||
</a>
|
||
|
||
|
||
<a href="../testing.html" class="navigation navigation-next " aria-label="Next page: Testing Guide">
|
||
<i class="fa fa-angle-right"></i>
|
||
</a>
|
||
|
||
|
||
|
||
</div>
|
||
|
||
<script>
|
||
var gitbook = gitbook || [];
|
||
gitbook.push(function() {
|
||
gitbook.page.hasChanged({"page":{"title":"Vue","level":"1.5.4","depth":2,"next":{"title":"Testing Guide","level":"1.6","depth":1,"path":"testing.md","ref":"testing.md","articles":[{"title":"End-to-end tests","level":"1.6.1","depth":2,"path":"cypress/README.md","ref":"cypress/README.md","articles":[]},{"title":"Frontend tests","level":"1.6.2","depth":2,"path":"webapp/testing.md","ref":"webapp/testing.md","articles":[]},{"title":"Backend tests","level":"1.6.3","depth":2,"path":"backend/testing.md","ref":"backend/testing.md","articles":[]}]},"previous":{"title":"SCSS","level":"1.5.3","depth":2,"path":"webapp/scss.md","ref":"webapp/scss.md","articles":[]},"dir":"ltr"},"config":{"plugins":["-lunr","-search","-sharing","hints","tabs2","theme-simple@git+https://github.com/plugins-zander/gitbook-plugin-theme-simple.git","search-pro@git+https://github.com/plugins-zander/gitbook-plugin-search-pro.git","splitter@git+https://github.com/plugins-zander/gitbook-plugin-splitter.git","edit-link@git+https://github.com/plugins-zander/gitbook-plugin-edit-link.git","gtag@git+https://github.com/plugins-zander/gitbook-plugin-gtag.git","chapter-fold@git+https://github.com/plugins-zander/gitbook-plugin-chapter-fold.git","copy-code-button@git+https://github.com/plugins-zander/gitbook-plugin-copy-code-button.git"],"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"},"pluginsConfig":{"chapter-fold":{},"splitter":{},"search-pro":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"sitemap-general":{"prefix":"https://zlogs.net/gitbook-action/"},"fontsettings":{"theme":"white","family":"sans","size":2},"gtag":{"token":""},"tabs2":{},"highlight":{},"theme-simple":{"showLevel":false,"styles":{"ebook":"styles/ebook.css","epub":"styles/epub.css","mobi":"styles/mobi.css","pdf":"styles/pdf.css","print":"styles/print.css","website":"styles/website.css"}},"copy-code-button":{},"edit-link":{"label":"EDIT","base":"https://github.com/Ocelot-Social-Community/Ocelot-Social/edit/master/"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","author":"busFaktor() e.V.","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Ocelot.Social – Developer Documentation","gitbook":"3.2.3","description":"Developer Documentation by Gitbook-Action"},"file":{"path":"webapp/vue.md","mtime":"2020-03-14T00:02:12.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2023-08-15T15:04:47.802Z"},"basePath":"..","book":{"language":""}});
|
||
});
|
||
</script>
|
||
</div>
|
||
|
||
|
||
<script src="../gitbook/gitbook.js"></script>
|
||
<script src="../gitbook/theme.js"></script>
|
||
|
||
|
||
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-tabs2/tabs.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-search-pro/jquery.mark.min.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-search-pro/search.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-splitter/splitter.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-gtag/plugin.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-chapter-fold/chapter-fold.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-copy-code-button/toggle.js"></script>
|
||
|
||
|
||
|
||
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|
||
|