Skip to content

Make HTML Elements documentation more present and more detailed #4394

@stefanuebe

Description

@stefanuebe

Flow provides a large set of components representing native HTML elements, like Div, Span, etc.

Those components partially play a significant role when building applications, e.g. Spans for text output. While there is a docs page introducing these components, the components themselves are not very well documented and require the dev to visit other pages like MDN to retrieve information about the intentional use of these components and other details.
Parallel to that is the docs page itself not listed in the components section, but somewhere inside the "basic" Flow documentation - a place where you normally don't look, when you want to know something about our set of components.

Therefore there are two requirements:

More details
Provide more detail regarding the different native HTML element components, for instance something like:

The <main> HTML element represents the dominant content of the <body> of a document. The main content area consists of content that is directly related to or expands upon the central topic of a document, or the central functionality of an application.

(quoted from MDN)

It should also provide a link to the respective MDN page, which contains all necessary details for that element, e.g. https://developer.mozilla.org/de/docs/Web/HTML/Reference/Elements/main (could of course also link to other pages, but I think those are very well written in many cases and provide a lot of easy to understand examples)

Better visibility
The HTML components docs page should also be listed under the Components root section, marked with a Flow tag.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions