aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/development.md b/docs/development.md
index 5e432f1..a22ae0b 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -1,5 +1,7 @@
1# Development 1# Development
2 2
3If you want to contribute to Homer, please read the [contributing guidelines](https://github.com/bastienwirtz/homer/blob/main/CONTRIBUTING.md) first.
4
3```sh 5```sh
4# Using yarn (recommended) 6# Using yarn (recommended)
5yarn install 7yarn install
@@ -10,6 +12,49 @@ npm install
10npm run serve 12npm run serve
11``` 13```
12 14
15## Custom services
16
17Custom services are small VueJs component (see `src/components/services/`) that add little features to a classic, "static", dashboard item. It should be very simple.
18A dashboard can contain a lot of items, so performance is very important.
19
20The [`Generic`](https://github.com/bastienwirtz/homer/blob/main/src/components/services/Generic.vue) service provides a typical card layout which
21you can extend to add specific features. Unless you want a completely different design, extended the generic service is the recommended way. It gives you 3 [slots](https://vuejs.org/v2/guide/components-slots.html#Named-Slots) to extend: `icon`, `content` and `indicator`.
22Each one is **optional**, and will display the usual information if omitted.
23
24Each service must implement the `item` [property](https://vuejs.org/v2/guide/components-props.html) and bind it the Generic component if used.
25
26### Skeleton
27```Vue
28<template>
29 <Generic :item="item">
30 <template #icon>
31 <!-- left area containing the icon -->
32 </template>
33 <template #content>
34 <!-- main area containing the title, subtitle, ... -->
35 </template>
36 <template #indicator>
37 <!-- top right area, empty by default -->
38 </template>
39 </Generic>
40</template>
41
42<script>
43import Generic from "./Generic.vue";
44
45export default {
46 name: "MyNewService",
47 props: {
48 item: Object,
49 },
50 components: {
51 Generic,
52 }
53};
54</script>
55```
56
57
13## Themes 58## Themes
14 59
15Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). 60Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).