doc: frontend doc rework #30
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davecoates
force-pushed
the
doc/rework-frontend-docs
branch
2 times, most recently
from
1801013 to
1254327
Compare
- Add documentation for templatetags in page so we have full control over formatting. The autofunction solution doesn't work well for templatetags as it can't properly extract any arguments - Add an overview page - Put all API style docs under the API section - Enhance the alliance_ui docs
davecoates
force-pushed
the
doc/rework-frontend-docs
branch
from
1254327 to
a1632f1
Compare
this should make it work better with PR previews
micahklaz
requested changes
Jun 5, 2024
| - In production it is handled by ``production-ssr-server.ts`` which works with the production built files. | ||
|
|
||
| Currently, the only thing that gets rendered on the server is React components. :class:`~alliance_platform.frontend.templatetags.react.ComponentSSRItem` | ||
| is used to describe the component that needs to be rendered. See it's documentation for details on how each component |
| <!-- Named export --> | ||
| {% component "components/Table" "Column" %}Header{% endcomponent %} | ||
| <!-- Pass a comopnent as a prop to another component --> | ||
| {% component "components/Icons" "Menu" as menu_icon %} |
There was a problem hiding this comment.
Does this need an endcomponent tag?
|
|
||
| Performs dev specific checks and may render some HTML to communicate messages to user | ||
|
|
||
| Currently check if the dev server is running for this project, and if not displays an error. |
| prefixed with `ssr:` for server side rendering options, `component:` for general component options, or `container:` | ||
| for options relating to the container the component is rendered into. | ||
|
|
||
| - ``ssr:disabled=True`` - if specified, no server side rendering will occur for this component |
There was a problem hiding this comment.
If rendering on the client, will this automatically handle <Suspense> and displaying some sort of loading icon? If not, is that something we want to support (perhaps as an additional ssr argument), or should mention in the documentation?
There was a problem hiding this comment.
Suspense isn't applicable here as it's not loading it within a React tree. We could support an option for it, e.g. ssr:placeholder=... to allow rendering something.
I'll add a note about it when SSR is disabled
davecoates
merged commit 0709c28
into
fix/render-component-ssr-explicit-disable
9 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generated docs are here