Documentation: Tile #1538
Documentation: Tile #1538
Conversation
gretanausedaite
requested review from
mayank99 and
r100-stack
and removed request for
a team
apps/website/src/pages/docs/tile.mdx
Outdated
| <AllExamples.TileActionableExample client:load /> | ||
| </LiveExample> | ||
|
|
||
| Tile can also link to another page. |
There was a problem hiding this comment.
Can mention why to use href in <Tile.Action> instead of wrapping the whole tile in <a href="...">
There was a problem hiding this comment.
Updated a bit. Feel free to rewrite things if you want.
apps/website/src/pages/docs/tile.mdx
Outdated
|
|
||
| ### Props API | ||
|
|
||
| Users can also take advantage of properties provided for `Tile`. A list of available properties can be found [at the end](#props) of this documentation. |
There was a problem hiding this comment.
What does it mean "Users can also take advantage of properties provided for Tile"? This doesn't really explain anything, as props are always available in every component.
There was a problem hiding this comment.
if it helps, you could look at expandable block documentation for ideas on how to separate composition and legacy apis. https://github.com/iTwin/iTwinUI/pull/1502/files#diff-19c324894ed0750aa99b244219e53d7e123753f73b594a0211986918f7bf4e03
There was a problem hiding this comment.
Despite the wording, what's wrong with my choice of documenting both apis?
There was a problem hiding this comment.
The example is fine, but the wording just feels unhelpful in general.
"You can take advantage of props" is not some new revelation; users can always take advantage of props. It might help to describe these props or mention which ones.
But the key difference is between directly using Tile vs only using subcomponents. See "usage" section here: https://dev-itwinui.bentley.com/docs/expandableblock#usage
There was a problem hiding this comment.
Updated, is it better now?
There was a problem hiding this comment.
I believe it would be helpful to have a separate section like the Expandable Block -> Usage link that Mayank shared. It can say something like, "you can use Tile in either one of two ways: ...".
This makes it clearer that we shouldn't mix the APIs. This also allows us to talk about the pros and cons of each API to help users decide which API to choose,
There was a problem hiding this comment.
2/3 find this approach "good enough".
Leaving as is for now.
Changes
Added documentation of the Tile.
Testing
N/A
Docs
N/A