[Feature] Enable `kwargs` for single component models (via `extra`) #1032

maxschulz-COL · 2025-02-20T16:34:53Z

Description

This PR introduces the extra arguments to the components: Container, Card, Button, Dropdown, Checklist, RadioItems, Slider, RangeSlider, DatePicker which are directly passed to their underlying foudation components, in this case dmc,dbc and dcc.

It is made clear in the API reference and argument docstring that this argument is not part of the Vizro schema, and may not be backwards compatible in future releases.

Main open question

Do we want to call the argument extra?

Alternatives considered

extra: Dict[str,Any] without merge extra with the defaults of a component
extra: Dict[str,Any] with nested merge of extra with the defaults of a component
extra: ComponentExtraType - where ComponentExtraType is a pydantic model of selected extra arguments that would enhance usability and error explanation

Open ToDoS

Write schema explanation
Write docs examples

Screenshot

Notice

I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":
- I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
- I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
- I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
- I have not referenced individuals, products or companies in any commits, directly or indirectly.
- I have not added data or restricted code in any commits, directly or indirectly.

for more information, see https://pre-commit.ci

…izro into dev/styled-containers

for more information, see https://pre-commit.ci

…izro into dev/styled-containers

for more information, see https://pre-commit.ci

petar-qb

Looks really clean now! 🥇

vizro-core/docs/pages/explanation/schema.md

vizro-core/src/vizro/models/_components/button.py

vizro-core/tests/unit/vizro/models/_components/test_button.py

tools/pycafe/test_pycafe_links.py

The once exception where I did not apply this was navigation as it seemed to complicated

antonymilne

Some more comments for now - will write some more here later!

https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/style

vizro-core/docs/pages/user-guides/card-button.md

vizro-core/docs/pages/user-guides/container.md

vizro-core/docs/pages/explanation/schema.md

Clarify language in `extra` argument explanations for Card, Button, and Container components to better describe their relationship with underlying Dash components

antonymilne

Let me know if you want me to check the docs/warning message any more after our discussion yesterday, but I'm happy for you to merge whenever you're happy with it.

vizro-core/changelog.d/20250303_110318_maximilian_schulz_enable_kwargs.md

vizro-core/src/vizro/models/_dashboard.py

Add notes to multiple user guide pages highlighting the `extra` argument as a quick way to customize components without creating custom components or CSS. Updated documentation for custom components, custom CSS, graph, and selectors to include guidance on using `extra` for quick modifications.

for more information, see https://pre-commit.ci

huong-li-nguyen and others added 30 commits February 10, 2025 10:20

Add rough POC on how styling can be done

4f90d82

Style modebar and change position

07caeb4

Make charts transparent in app only for now

8d8b7d0

[pre-commit.ci] auto fixes from pre-commit.com hooks

5cd10fe

for more information, see https://pre-commit.ci

Merge branch 'main' into dev/styled-containers

5652dac

Tidy

38343ec

[pre-commit.ci] auto fixes from pre-commit.com hooks

6179c2a

for more information, see https://pre-commit.ci

Merge branch 'main' into dev/styled-containers

352be9a

Update custom.css

74e9baa

Add card to check compatibility

33f028f

[pre-commit.ci] auto fixes from pre-commit.com hooks

7c8085b

for more information, see https://pre-commit.ci

Fix re-sizing

71942ac

Merge branch 'dev/styled-containers' of https://github.com/mckinsey/v…

1637d5f

…izro into dev/styled-containers

[pre-commit.ci] auto fixes from pre-commit.com hooks

869cde9

for more information, see https://pre-commit.ci

Use dbc.Container and update CSS

46db73f

Add unstyled container to example

0e5b6d7

[pre-commit.ci] auto fixes from pre-commit.com hooks

8a41c26

for more information, see https://pre-commit.ci

Update docs

dcfdaec

Lint

e494abb

Merge branch 'dev/styled-containers' of https://github.com/mckinsey/v…

855bc95

…izro into dev/styled-containers

Update 20250217_105619_huong_li_nguyen_styled_containers.md

001c51f

Merge branch 'main' into dev/styled-containers

ad08fd5

Remove non-existing docs section

e5925fa

Update docs

dd2d3d8

Merge branch 'main' into dev/styled-containers

68cbf35

[pre-commit.ci] auto fixes from pre-commit.com hooks

e8071b0

for more information, see https://pre-commit.ci

Add cross-reference link to custom css

a8bb0a7

[pre-commit.ci] auto fixes from pre-commit.com hooks

67c7bb4

for more information, see https://pre-commit.ci

Merge branch 'main' into dev/styled-containers

6e78d22

Merge branch 'dev/styled-containers' into feature/enable_kwargs

ce6ad06

PR comments

327b237

petar-qb approved these changes Mar 4, 2025

View reviewed changes

vizro-core/docs/pages/explanation/schema.md Outdated Show resolved Hide resolved

vizro-core/src/vizro/models/_components/button.py Show resolved Hide resolved

vizro-core/tests/unit/vizro/models/_components/test_button.py Show resolved Hide resolved

maxschulz-COL added 2 commits March 4, 2025 14:11

Pr comments

c5afd39

PR feedback

abc0a4e

maxschulz-COL changed the title ~~[Feature] Enable kwargs for single component models~~ [Feature] Enable kwargs for single component models (via extra) Mar 4, 2025

maxschulz-COL added 3 commits March 4, 2025 16:20

Merge branch 'main' into feature/enable_kwargs

4aba923

PR comments

f36ba0b

Sneak in two changes that should stabilise the tests a bit

0645491

maxschulz-COL commented Mar 4, 2025

View reviewed changes

tools/pycafe/test_pycafe_links.py Outdated Show resolved Hide resolved

maxschulz-COL added 3 commits March 5, 2025 10:46

Merge branch 'main' into feature/enable_kwargs

5a40d79

Change deprecated className to class_name

85ebae3

The once exception where I did not apply this was navigation as it seemed to complicated

Schema update

b2f98a9

antonymilne reviewed Mar 5, 2025

View reviewed changes

Improve documentation for extra argument descriptions

cf1a54b

Clarify language in `extra` argument explanations for Card, Button, and Container components to better describe their relationship with underlying Dash components

antonymilne approved these changes Mar 6, 2025

View reviewed changes

vizro-core/changelog.d/20250303_110318_maximilian_schulz_enable_kwargs.md Outdated Show resolved Hide resolved

vizro-core/src/vizro/models/_dashboard.py Outdated Show resolved Hide resolved

vizro-core/src/vizro/models/_dashboard.py Outdated Show resolved Hide resolved

maxschulz-COL and others added 12 commits March 6, 2025 16:21

PR comments A

b77f196

Add example to inline radio

a19fb63

Soften language on extra

3354860

Schema update

740b197

Merge branch 'main' into feature/enable_kwargs

921e840

[pre-commit.ci] auto fixes from pre-commit.com hooks

007e8cb

for more information, see https://pre-commit.ci

Fix broken anchor

bed413a

Mention more the underlying dash component

30de90a

[pre-commit.ci] auto fixes from pre-commit.com hooks

39be3a1

for more information, see https://pre-commit.ci

Last fixes

7fc2246

Fix

a3360ad

maxschulz-COL enabled auto-merge (squash) March 7, 2025 13:41

maxschulz-COL merged commit 3d2fd2c into main Mar 7, 2025
41 checks passed

maxschulz-COL deleted the feature/enable_kwargs branch March 7, 2025 13:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feature] Enable `kwargs` for single component models (via `extra`) #1032

[Feature] Enable `kwargs` for single component models (via `extra`) #1032

maxschulz-COL commented Feb 20, 2025 •

edited

Loading

petar-qb left a comment

antonymilne left a comment

antonymilne left a comment

[Feature] Enable kwargs for single component models (via extra) #1032

[Feature] Enable kwargs for single component models (via extra) #1032

Conversation

maxschulz-COL commented Feb 20, 2025 • edited Loading

Description

Main open question

Alternatives considered

Open ToDoS

Screenshot

Notice

petar-qb left a comment

Choose a reason for hiding this comment

antonymilne left a comment

Choose a reason for hiding this comment

antonymilne left a comment

Choose a reason for hiding this comment

[Feature] Enable `kwargs` for single component models (via `extra`) #1032

[Feature] Enable `kwargs` for single component models (via `extra`) #1032

maxschulz-COL commented Feb 20, 2025 •

edited

Loading