-
Notifications
You must be signed in to change notification settings - Fork 318
Components #958
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
Merged
Merged
Components #958
Conversation
This file contains hidden or 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
948e6dc
to
88f8d13
Compare
montanalow
reviewed
Aug 29, 2023
@@ -0,0 +1,10 @@ | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this extra whitespace?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, trim should of worked, good question.
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.
Components
Introducing server-side rendered frontend components. The idea is pretty simple: use composition like in React to build UIs, except the components are type-checked and rendered by the backend.
The base component can render any other component, including just strings. To make a Sailfish template into a component, just call
component!
on the struct, e.g:component!(MyTemplateStruct)
.MyTemplateStruct
must be derived fromsailfish::TemplateOnce
.CLI
To help with building components, we've created a
cargo
command that bundles CSS and JS into their respective bundles and can also generate components.To install the CLI:
Bundling
Run this after changing Sass or JS code:
cargo pgml-components bundle
.Creating new components
This will automatically generate:
sailfish::TemplaceOnce
Misc
/playground
page where we should test and render components. Analogous to how Material UI does it: https://mui.com/material-ui/react-autocomplete/