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

Optional Vue/Vuex tools pane. #46

Open
Decipher opened this issue Aug 19, 2020 · 2 comments
Open

Optional Vue/Vuex tools pane. #46

Decipher opened this issue Aug 19, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@Decipher
Copy link

As a developer I want to provide tools for my users to manipulate Vue live based documentation of components that rely on Vuex data.

I'm currently working on a set of modules, all heavily documented, that interconnect and via common Vuex stores.
I have put together a custom Vuepress theme that provides some initial mock data for my live examples: https://github.com/druxt/vuepress-theme-druxt/blob/feature/1-poc/enhanceApp.js

The main issue I face is that if a user changes the Live demo and references Vuex data that is not present it will not work.

Having the ability to show the Vuex data, and an easy way for a user to manipulate said data, should resolve the issue.

I suspect this could already be done with a custom layout for Vue Live, but that's a bit tricker as I am using Vue Live via the Vuepress plugin.

@elevatebart
Copy link
Member

Hello @Decipher,

That is a brilliant idea. An I think it could help a lot of users. I am little afraid of adding it in vue-live since it is not standard component code.

There is good new though: the undocumented (I should fix that momentarily) option layout in the vuepress plugin. It allows us to have any layout we like in the vuepress plugin. In other words we could do it ourselves using the layout.

@Decipher
Copy link
Author

Thanks @elevatebart, I'll give that a spin.

As for a common solution, maybe a vue-live-vuex plugin or similar?

Regardless, if I knock together something workable I'll try to update this issue.

@elevatebart elevatebart added the enhancement New feature or request label Aug 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants