Skip to content

Commit

Permalink
docs: add pinia order in contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
kelsos committed Sep 18, 2024
1 parent ed28f9c commit a1b6fdc
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions contribution-guides/vue-typescript.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,45 @@ defineExpose({
});
```

### Pinia Store

For pinia stores the suggested order for elements is the following.

```typescript
// stores/counter.ts
import { defineStore } from 'pinia';
import { computed, ref } from 'vue';

export const useCounterStore = defineStore('counter', () => {
// 1. State
const count = ref<number>(0);

// 2. Getters
const doubleCount = computed(() => count.value * 2);

// 3. Actions
function increment(): void {
count.value++;
}

function decrement(): void {
count.value--;
}

// 4. Watchers
watch(count, (count) => {
// do something
});

return {
count,
doubleCount,
increment,
decrement,
};
});
```

### useCssModules

It should be only used if there is some access to the css module class names inside the script tag.
Expand Down

0 comments on commit a1b6fdc

Please sign in to comment.