search

milesj / docusaurus-plugin-typedoc-api

Docusaurus plugin that provides source code API documentation powered by TypeDoc.
71 stars 26 forks source link

feat: Support for Page Options - Hide Inherited [#150] #151

Closed rash805115 closed 2 months ago

rash805115 commented 3 months ago

This PR is to add support for page options, the first one including Hide Inherited as explained in #150 .

As shown in screenshot, at the top of the page you can see a new option - Page Options.


When unchecked (default), the page would show normally.

Screenshot 2024-08-03 at 2 15 51 PM



When checked, all attributes that were inherited, in sidebar and in page content, are hidden.

Screenshot 2024-08-03 at 2 15 59 PM
milesj commented 3 months ago

The functionality is nice but the placement of the UI needs work. Adds too much space.

rash805115 commented 3 months ago

Hmm I agree. What would you suggest? Maybe keep the Page Options div but make the actual options (next div) collapsible? I was thinking if more options are ever added, they would be in line with the other options, so the height you see should not be more than what it is today.

milesj commented 3 months ago

Maybe in the sidebar somewhere? Not sure if possible.

rash805115 commented 3 months ago

That was my first try, in the right sidebar. But the UI was looking ugly, especially in mobile.

rash805115 commented 3 months ago

I think I made it to sidebar, and it looks better than before for sure.

Look on mobile,

Screenshot 2024-08-04 at 10 25 48 AM

Look on desktop,

Screenshot 2024-08-04 at 10 26 06 AM
rash805115 commented 3 months ago

Hi @milesj Can you take a look when you have a chance?

milesj commented 3 months ago

I'm out of town for the new few weeks.

rash805115 commented 2 months ago

Hello @milesj Just checking again if you are back in town, and if you can review this PR.