Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add pinia order in contribution #15

Merged
merged 1 commit into from
Sep 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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