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

Show inherited properties/methods in the APIRef sidebar #169

Open
ADTC opened this issue Sep 24, 2021 · 9 comments
Open

Show inherited properties/methods in the APIRef sidebar #169

ADTC opened this issue Sep 24, 2021 · 9 comments
Labels
idle Issues and pull requests with no activity for three months. p3 We don't have visibility when this will be addressed.

Comments

@ADTC
Copy link

ADTC commented Sep 24, 2021

What page(s) did you find the problem on?

https://developer.mozilla.org/en-US/docs/Web/API/File/size
https://developer.mozilla.org/en-US/docs/Web/API/File

Specific page section or heading?

(Sidebar) Related Topics > Properties
image

What is the problem?

The sidebar doesn't have a link to the size property.

What did you expect to see?

The sidebar has a link to the size property.

Did you test this? If so, how?

I checked the File API specification. The size property is listed under Instance properties as File.prototype.size.

@ADTC ADTC added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Sep 24, 2021
@ADTC ADTC changed the title Content bug: File.size (File API) Content bug: File.size (File API) is not on the sidebar Sep 24, 2021
@teoli2003
Copy link

That's because File.size is in fact defined on Blob. That page should be a redirect to Blob.size. I agree that inherited properties/methods are a bit hidden, though.

@teoli2003
Copy link

teoli2003 commented Sep 24, 2021

To make it appear on the sidebar, we should modify the macro. @Elchi3, @wbamberg, @Rumyra: do you think we should?

@schalkneethling
Copy link

To make it appear on the sidebar, we should modify the macro. @Elchi3, @wbamberg, @Rumyra: do you think we should?

Friendly ping to @Rumyra for your thoughts on this issue. Thank you.

@Rumyra
Copy link

Rumyra commented Jun 17, 2022

I think this is a good issue to address with the work (and discussion) around page types, organising web apis and that sidebar work - I haven't made a decision, but the options are:

  • Add to sidebar for clarity now
  • Wait until the above work is done because it should be addressed

@schalkneethling
Copy link

@teoli2003 Thoughts on the above?

@teoli2003
Copy link

I don't think the current sidebar system allows for adding it to the sidebar. (Without a significant revamp). It just doesn't list inherited properties and methods, only a link to the inherited interfaces.

So this will need to wait for engineering time to move the sidebars from macros to yari (using page-type, etc), I guess.

@sideshowbarker sideshowbarker removed the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jun 22, 2022
@schalkneethling
Copy link

I don't think the current sidebar system allows for adding it to the sidebar. (Without a significant revamp). It just doesn't list inherited properties and methods, only a link to the inherited interfaces.

So this will need to wait for engineering time to move the sidebars from macros to yari (using page-type, etc), I guess.

Does it then make more sense to move this to Yari?

@wbamberg
Copy link

I don't think the current sidebar system allows for adding it to the sidebar. (Without a significant revamp). It just doesn't list inherited properties and methods, only a link to the inherited interfaces.
So this will need to wait for engineering time to move the sidebars from macros to yari (using page-type, etc), I guess.

Does it then make more sense to move this to Yari?

Either way this is a Yari bug, since sidebars are implemented in KS now, and that is in Yari.

@wbamberg wbamberg transferred this issue from mdn/content Jun 22, 2022
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Jun 22, 2022
@caugner caugner changed the title Content bug: File.size (File API) is not on the sidebar Show inherited properties in the APIRef sidebar Nov 11, 2022
@caugner caugner added p3 We don't have visibility when this will be addressed. and removed needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Nov 11, 2022
@caugner
Copy link
Contributor

caugner commented Nov 11, 2022

To show inherited properties (and methods!?) in the APIRef sidebar, we can use the same data source as the InheritanceDiagram macro (i.e. the InterfaceData.json).

Requirements:

  1. Show all inherited properties and methods in the sidebar, unless they are overridden (e.g. Blob.type -> File.type).
  2. Make them distinguishable (since navigating to an inherited property or method will lead to a different sidebar).

@caugner caugner changed the title Show inherited properties in the APIRef sidebar Show inherited properties/methods in the APIRef sidebar Nov 11, 2022
@github-actions github-actions bot added the idle Issues and pull requests with no activity for three months. label Jan 17, 2023
@caugner caugner transferred this issue from mdn/yari Mar 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
idle Issues and pull requests with no activity for three months. p3 We don't have visibility when this will be addressed.
Projects
Status: No status
Development

No branches or pull requests

7 participants