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

Document Field Module API #492

Open
jgaehring opened this issue Feb 26, 2022 · 0 comments
Open

Document Field Module API #492

jgaehring opened this issue Feb 26, 2022 · 0 comments

Comments

@jgaehring
Copy link
Member

I'll expand on this later, but here's the general outline:

  • App Shell
    • provide/inject (for data and methods like errors and alert respectively)
  • Component Library
  • Global farm object (aka, Entities API)
  • Global lib object
  • Global utils object
  • $t() (see 2.x Localization #456)

I can also refer to scrapped 1.x docs for this, even though they're totally wrong, since the API features should at least have an analog to operations for the 2.x API.

A few caveats though...

I'm really not sure about the localization stuff. I won't have time to re-implement it before the release of this API, and I wonder whether I really want to fully document it til then, but it will bear some consideration.

I'm also not sure about what to do with the component library, since Storybook really was the main documentation there, and it's been a real PITA to get up and running again since migrating to Vite/Vue3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant