@antfu I have create a toggle button on the top of the sidebar in this PR. The PR is still in progress as now I have to write all the switchable content for all the functions. I wanted some clarification from you on some thing.

In the PR, I have written the typescript code snippet for createGlobalState as follows:

// store.ts
import { ref } from 'vue'
import { createGlobalState } from '@vueuse/core'
export const useGlobalState = createGlobalState(
  () => {
    const count = ref(0)
    return { count }
  }
)

This is same as the javascript code. This is because all the types are already inferred from the createGlobalState function in the output. Is this okay? Or should I write the function as below:

// store.ts
import { ref } from 'vue'
import { createGlobalState } from '@vueuse/core'

function storageFn() {
    const count = ref(0)
    return { count }
}
export const useGlobalState = createGlobalState<typeof storageFn>(storageFn)

Also request you to take a look at the toggle component I made for toggling the code i.e. TsJsToggleSwitch.vue. I have implemented it exactly as the api preference switch in vuejs documentation. I am not really an expert in CSS, but I have done the best I could.

Thanks!

I think we should not manually write js/ts docs version at all, to avoid increasing the maintenance burden.

Instead, as I suggested (#2475 (comment)), we should always write in TS, and use a custom plugin to generate the js version from the ts blocks using esbuild at compile time

Thanks for your reply @antfu . Can you also tell me which of the above typescript code snippets should I use for createGlobalState function?

Hey @antfu , As suggested by you, I have created a plugin that will create a JS frame for the typescript snippet it finds in all the index.md files. Can you review it once? I can then change the JS snippets in every function to show typescript by default and they can be transpiled to JS frames on build time?

@antfu Request you to please check if the plugin I created for typescript transpilation to javascript is what we require? I can then move ahead with converting code snippets to typescript for other functions...

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.