Display flags next to class name #1914
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reflections in TypeDoc can be assigned flags, describing certain properties of the reflection, e.g. abstract, private, readonly etc. These flags were rendered using badges for most type of reflections, but not for reflections which are displayed on their own page (like classes, interfaces etc.). This made it difficult to establish e.g. whether a class is abstract (see TypeStrong#1874). This PR fixes the issue by rendering flags in the page titles next to the name of the documented entity. Styling of the badges has been amended, to account for them now showing next to much bigger headings. The styling was inspired by [Bootstrap badges](https://getbootstrap.com/docs/4.0/components/badge/). Partially resolves TypeStrong#1874.
|
Preview of the changes (for abstract classes):
|
|
I like it, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reflections in TypeDoc can be assigned flags, describing certain
properties of the reflection, e.g. abstract, private, readonly etc.
These flags were rendered using badges for most type of reflections, but
not for reflections which are displayed on their own page (like classes,
interfaces etc.). This made it difficult to establish e.g. whether a
class is abstract (see #1874).
This PR fixes the issue by rendering flags in the page titles next to
the name of the documented entity.
Styling of the badges has been amended, to account for them now showing
next to much bigger headings. The styling was inspired by Bootstrap
badges.
Partially resolves #1874.