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

Missing documentation of align_items parameter in row/column/card #3602

Closed
frankhuurman opened this issue Aug 26, 2024 · 3 comments
Closed
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@frankhuurman
Copy link
Contributor

frankhuurman commented Aug 26, 2024

Description

I noticed that in release 1.4.27 the align_items parameter got added to ui.row, ui.column and ui.card and wanted to see how this works but on the documentation pages of these elements(https://nicegui.io/documentation/column for exampe) I can only find:

image

So I only know the default value is None but I don't know which value(or type) I could use to align the items(e.g. horizontal/vertical/center/left/right?). I couldn't find it on the rest of the documentation page either.

Can't wait to try it out :)

@frankhuurman
Copy link
Contributor Author

Found out that "center" works as a value :)

@falkoschindler
Copy link
Contributor

The align_items is type-annotated like this:

align_items: Optional[Literal['start', 'end', 'center', 'baseline', 'stretch']] = None,

We tend to expect the users to use modern IDEs with type hints. But I guess we can duplicate the possible values in the docstring

@falkoschindler falkoschindler added the documentation Improvements or additions to documentation label Aug 26, 2024
@falkoschindler falkoschindler added this to the 1.4.37 milestone Aug 26, 2024
@frankhuurman
Copy link
Contributor Author

@falkoschindler
I use VS Code but didn't point the editor to my new venv yet which is why I didn't see the suggestions.
But I did have the expectation of finding possible values in the online documentation, not sure if that's just me.

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

No branches or pull requests

4 participants
@falkoschindler @frankhuurman and others