Skip to content

Document Field Module API #492

@jgaehring

Description

@jgaehring

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions