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

docs(Tabs): improve property docs #3665

Merged
merged 1 commit into from
Jun 13, 2024
Merged

Conversation

langz
Copy link
Contributor

@langz langz commented Jun 5, 2024

I feel that the properties docs of tabs is not very readable because of how the data property's type is formatted.

This is just a suggestion, but instead of changing the values of the type property(as I've done in the PR here) we should probably change the styling or so, to accomplish the same. Perhaps the PropertiesTable is the correct place to change? 🤔

From:

Screenshot 2024-06-05 at 13 54 05

To:

Screenshot 2024-06-05 at 13 53 58

Copy link

vercel bot commented Jun 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
eufemia ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 12, 2024 1:18pm

Copy link
Contributor

@joakbjerk joakbjerk left a comment

Choose a reason for hiding this comment

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

I find the new proposal more readable 👍 Not a big fan of horizontal scrolling when reading, so mitigating that would be nice 😄

Copy link
Member

@tujoworker tujoworker left a comment

Choose a reason for hiding this comment

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

Nice improvement 🚀

@tujoworker
Copy link
Member

tujoworker commented Jun 12, 2024

Actually, looking at this closer, we should use the same approach as done with ProgressIndicator, where a value as object gets a new table. Added a commit for this.

Screenshot 2024-06-12 at 15 12 43

@langz
Copy link
Contributor Author

langz commented Jun 13, 2024

Actually, looking at this closer, we should use the same approach as done with ProgressIndicator, where a value as object gets a new table. Added a commit for this.

Screenshot 2024-06-12 at 15 12 43

Great, seems like a way better way of solving it then what I suggested 👍

@langz langz merged commit 7849cba into main Jun 13, 2024
9 checks passed
@langz langz deleted the docs/improve-prop-docs-of-tabs branch June 13, 2024 15:26
tujoworker pushed a commit that referenced this pull request Jun 14, 2024
## [10.36.0](v10.35.0...v10.36.0) (2024-06-14)

### ✨ Features

* **Anchor:** add helper classes as props ([#3701](#3701)) ([62b23e8](62b23e8))
* **forms:** add `activeWhen` prop to Wizard.Step ([#3705](#3705)) ([edd6214](edd6214))
* **Icon:** rewrite to TypeScript and hooks ([#3703](#3703)) ([70b1f8b](70b1f8b)), closes [#3699](#3699)
* **Table:** refactoring of types, documentation, and accordion file structure ([#3683](#3683)) ([6045e42](6045e42))

### 🐛 Bug Fixes

* **Autocomplete:** make `input_value` react to prop change ([#3706](#3706)) ([641e5e7](641e5e7))
* **Autocomplete:** make inputValue update on data prop changes ([#3581](#3581)) ([83b05cf](83b05cf))
* **forms:** ensure useReactRouter to handle initial data given by url ([#3708](#3708)) ([a16f1f7](a16f1f7)), closes [#3702](#3702)
* **StepIndicator:** avoid re-assigning functions that can cause titles to be not in sync ([#3697](#3697)) ([d8d740c](d8d740c)), closes [#3685](#3685)

### 📝 Documentation

* **forms:** add translations table ([#3693](#3693)) ([84605b7](84605b7))
* **Tabs:** fix the title of Tabs breakout example ([#3696](#3696)) ([7747e06](7747e06))
* **Tabs:** improve property docs ([#3665](#3665)) ([7849cba](7849cba))
* update grid layout example without responsive sidebar ([#3709](#3709)) ([f4363c2](f4363c2))
@tujoworker
Copy link
Member

🎉 This PR is included in version 10.36.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

3 participants