Skip to content

Create an interface for column components other than MultiDocRef #86

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

Merged
merged 14 commits into from
Feb 27, 2025

Conversation

asinghvi17
Copy link
Contributor

We wanted to add some custom components (external links SciML/SciMLDocs#240, commercial support icons, etc.) but the current structure of MultiDocumenter constrains this to MultiDocRef.

This PR introduces an abstract supertype of MultiDocRef, DropdownComponent (name up for review) where the only interface requirement is that the subtype implements render(::Component, doc, page, prettyurls). This can be used to create arbitrary components that are rendered as arbitrary HTML, within the column environment.

asinghvi17 and others added 4 commits February 20, 2025 10:57
Co-authored-by: semgrep-code-juliacomputing-new[bot] <177960334+semgrep-code-juliacomputing-new[bot]@users.noreply.github.com>
@asinghvi17
Copy link
Contributor Author

Looks like Windows tests are failing because of an extra carriage return (\r). Might add a chomp to that just to normalize whitespace.

@asinghvi17 asinghvi17 marked this pull request as ready for review February 20, 2025 16:56
@asinghvi17 asinghvi17 requested a review from pfitzseb February 26, 2025 16:42
@asinghvi17
Copy link
Contributor Author

We can make Link look pretty in a separate PR - this is ready from my end now!

Co-authored-by: Sebastian Pfitzner <pfitzseb@gmail.com>
@pfitzseb pfitzseb merged commit 730eb48 into main Feb 27, 2025
8 of 11 checks passed
@asinghvi17 asinghvi17 deleted the as/flexible_column_components branch May 16, 2025 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants