You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 17, 2022. It is now read-only.
Is your feature request related to a problem? Please describe.
When trying to learn more about a given API in the docs it can be difficult to locate the component specific properties and methods; as they are mixed with all its inherited ones.
Describe the solution you'd like
Instead of having the component properties and methods mixed in with the sea of inherited properties and methods, I propose a separation within the Index.
Describe alternatives you've considered
Doing a ⌘F (find in page), but that's not very useful if you don't already know what you're looking for.
Scrolling all the way to the bottom of the page to workout what the little icons mean. And then trying to spot the ones you want (ain't no body got time for that). And something new devs could easily miss.
Additional context
The Current Index Structure
Index
Constructors
The constructor(s).
Properties
All properties (including inherited etc...), in alphabetical order.
Methods
All methods (including inherited etc...), in alphabetical order.
Proposed Index Structure
Index
Constructors
The constructor(s).
Properties
The specific component properties.
Methods
The specific component methods.
Inherited Properties
The inherited properties.
Inherited Methods
The inherited methods.
Additional Proposal
For accessibility and to improve the learning curve (RE what the icons mean), all links should use the title attribute. The title value could follow something like, [Inherited] <property-name>.
The Legend section could be moved to the top of the page. Maybe a collapsible component.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
When trying to learn more about a given API in the docs it can be difficult to locate the component specific properties and methods; as they are mixed with all its inherited ones.
Describe the solution you'd like
Instead of having the component properties and methods mixed in with the sea of inherited properties and methods, I propose a separation within the Index.
Describe alternatives you've considered
Additional context
The Current Index Structure
The constructor(s).
All properties (including inherited etc...), in alphabetical order.
All methods (including inherited etc...), in alphabetical order.
Proposed Index Structure
The constructor(s).
The specific component properties.
The specific component methods.
The inherited properties.
The inherited methods.
Additional Proposal
title
attribute. The title value could follow something like,[Inherited] <property-name>
.The text was updated successfully, but these errors were encountered: