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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add documentation and examples for Figure #524

Merged
merged 123 commits into from
Jun 20, 2024
Merged

[Docs] Add documentation and examples for Figure #524

merged 123 commits into from
Jun 20, 2024

Conversation

huong-li-nguyen
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen commented Jun 13, 2024 •
edited
Loading

Description

  • Add How-to-guide for Figure
  • Add How-to-guide for custom Figure
  • Update features examples dashboard with Figure and custom Figure
  • Tidy API reference

https://vizro--524.org.readthedocs.build/en/524/pages/user-guides/figure/
https://vizro--524.org.readthedocs.build/en/524/pages/user-guides/custom-figures/

More cross-links to the KPI card functions can be found in this PR: #529

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.

huong-li-nguyen and others added 30 commits May 21, 2024 13:17
@huong-li-nguyen
Add KPI Card based on Plotly indicator
fb37101
@huong-li-nguyen
Add KPI Card based on custom component
9428969
@huong-li-nguyen
Refine and leave some comments
c2c3710
@huong-li-nguyen
Get dynamic Card working quickly
dbba0dd
@huong-li-nguyen
Add logic to enable text_card and nav_card
a3ca6f6
@huong-li-nguyen
Tidy
521954a
@huong-li-nguyen
Lint
1081cd2
@huong-li-nguyen
Add partially styled KPI
4ceeed8
@huong-li-nguyen
Simplify dynamic styled card
1ca2be2
@huong-li-nguyen
Tidy
bba9e01
@huong-li-nguyen
Add styling to mkd card
e1a2858
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
8309d9f 
for more information, see https://pre-commit.ci
@huong-li-nguyen
Add another KPI style
7edfec2
@huong-li-nguyen
Merge branch 'feat/create_kpi_cards' of https://github.com/mckinsey/v…
c65678e 
…izro into feat/create_kpi_cards
@huong-li-nguyen
Lint
798d8ef
@huong-li-nguyen
Add comments
c01a3db
@huong-li-nguyen
Tidy CSS
6062063
@huong-li-nguyen
Make sample page with 3 pre-selected designs
67d41aa
@huong-li-nguyen
Move dbc.Card to build and remove id provision
6eedfe7
@huong-li-nguyen
Refactor classNames for kpi_card_icon
f3b1d6a
@huong-li-nguyen
Refactor simple and icon KPI card to one
feaf493
@huong-li-nguyen
Refactor classNames for kpi_card_ref
466b252
@huong-li-nguyen
Refactor and tidy some more
35f64aa
@huong-li-nguyen
Add formatting arguments to function for discussion
284f2ba
@huong-li-nguyen
Enable coloring of higher-level card
eb2c9c6
@huong-li-nguyen
Improve naming
456eb29
@huong-li-nguyen
Remove remaining kpi-card-icon reference
3f87ac9
@huong-li-nguyen
Tidy app
67321aa
@huong-li-nguyen
Merge branch 'main' into feat/create_kpi_cards
3aab16b
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
289ada3 
for more information, see https://pre-commit.ci
@huong-li-nguyen
Copy link
Contributor Author

@antonymilne @stichbury - could the two of you take a final look? Thank you! 🙏

antonymilne
antonymilne approved these changes Jun 20, 2024
View reviewed changes
Copy link
Contributor

@antonymilne antonymilne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really great set of examples! Thank you for all your hard work on this 🙏

vizro-core/docs/pages/user-guides/custom-charts.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/figure.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user-guides/custom-figures.md Outdated Show resolved Hide resolved
stichbury
stichbury approved these changes Jun 20, 2024
View reviewed changes
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🌟

@huong-li-nguyen huong-li-nguyen enabled auto-merge (squash) June 20, 2024 11:58
@huong-li-nguyen huong-li-nguyen merged commit e7c1181 into main Jun 20, 2024
33 checks passed
@huong-li-nguyen huong-li-nguyen deleted the docs/add-figure branch June 20, 2024 12:22
@antonymilne antonymilne mentioned this pull request Jun 24, 2024
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@antonymilne antonymilne antonymilne approved these changes

@stichbury stichbury stichbury approved these changes

@Joseph-Perkins Joseph-Perkins Awaiting requested review from Joseph-Perkins Joseph-Perkins is a code owner

@maxschulz-COL maxschulz-COL Awaiting requested review from maxschulz-COL maxschulz-COL is a code owner

@Anna-Xiong Anna-Xiong Awaiting requested review from Anna-Xiong

@lingyielia lingyielia Awaiting requested review from lingyielia lingyielia is a code owner

Assignees

@huong-li-nguyen huong-li-nguyen

Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@huong-li-nguyen @antonymilne @stichbury