Skip to content

feat(docs): allow propComponents from another source #3397

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.

Sign up for GitHub

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
evwilkin merged 1 commit into from
Feb 7, 2023
Merged

feat(docs): allow propComponents from another source #3397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/documentation-framework/scripts/md/parseMD.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,10 @@ function toReactComponent(mdFilePath, source, buildMode) {
}

const propComponents = [...new Set(frontmatter.propComponents || [])].reduce((acc, componentName) => {
const name = getTsDocName(componentName, getTsDocNameVariant(source));
// Use object properties if passed as propComponent
const component = componentName.component || componentName;
const src = componentName.source || source;
const name = getTsDocName(component, getTsDocNameVariant(src));

if (tsDocs[name]) {
acc.push(tsDocs[name]);
Expand Down
1 change: 1 addition & 0 deletions ...mework/templates/patternfly-docs/content/extensions/extension/examples/basic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ id: My extension
source: react
# If you use typescript, the name of the interface to display props for
# These are found through the sourceProps function provdided in patternfly-docs.source.js
# Can also pass object { component: string, source: string } allowing to specify the source
propComponents: ['Button']
---

Expand Down