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

[Bug] hidden: true in NgDocPage-Config does not avoid displaying a component in the navigation. #158

Closed
BenjaminLP opened this issue May 3, 2024 · 7 comments
Assignees
Labels
Status: Released Type: Bug Something isn't working

Comments

@BenjaminLP
Copy link

Is this a regression?

I don't know

Description

At https://ng-doc.com/docs/api/core/interfaces/NgDocPage an attribute "hidden" is listed. Description of this attribute describe how to avoid displaying a component in documentation. It seems, that this attribute has no function at all.

Please provide the exception or error you saw

No response

OS

Unix (Linux, macOS, etc.)

Browser

Chrome

Node version

18.13.0

Anything else?

const Button: NgDocPage = {
title: myButton,
mdFile: './index.md',
category: ComposedComponentsCategory,
demos: { ButtonDemoComponent },
imports: [ButtonComponent],
hidden: true,
playgrounds: { ... }
}

@BenjaminLP BenjaminLP added the Type: Bug Something isn't working label May 3, 2024
@skoropadas
Copy link
Member

skoropadas commented May 3, 2024

Well, it does exactly what the doc says "If true the page will be hidden from the sidebar", so it affects only the sidebar but not other things, do you wanna stop displaying some pages in your doc?

@skoropadas
Copy link
Member

or you still have it in the sidebar?

@BenjaminLP
Copy link
Author

Yes, that was the plan, but without removing the entire documentation-part.

@BenjaminLP
Copy link
Author

i added the attribute to the config of one component to hide it from the main navigation. But without success.

@skoropadas
Copy link
Member

Ah I see, that was a stuping typo in the code, I'll release a fix in a moment

skoropadas pushed a commit that referenced this issue May 3, 2024
## [17.6.7](v17.6.6...v17.6.7) (2024-05-03)

### Bug Fixes

* **builder:** setting `hidden: true` for the page doesn't have an effect ([6cf9aaa](6cf9aaa)), closes [#158](#158)
@skoropadas
Copy link
Member

🎉 This issue has been resolved in version 17.6.7 🎉

The release is available on:

Your semantic-release bot 📦🚀

@BenjaminLP
Copy link
Author

Wow, very fast. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Released Type: Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants