Skip to content

Commit 8f0abd5

Browse files
authored
fix(docs): deprecated message for props (ionic-team#2642)
1 parent 6593fe8 commit 8f0abd5

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

‎scripts/api.js‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,21 +60,24 @@ function renderProperties({ props: properties }) {
6060
// NOTE: replaces | with U+FF5C since MDX renders \| in tables incorrectly
6161
return `
6262
${properties
63-
.map(
64-
(prop) => `
65-
### ${prop.name}
63+
.map((prop) => {
64+
const isDeprecated = prop.deprecation !== undefined;
65+
66+
const docs = isDeprecated ? `${prop.docs}\n_Deprecated_ ${prop.deprecation}` : prop.docs;
67+
68+
return `
69+
### ${prop.name} ${isDeprecated ? '(deprecated)' : ''}
6670
6771
| | |
6872
| --- | --- |
69-
| **Description** | ${formatMultiline(prop.docs)} |
73+
| **Description** | ${formatMultiline(docs)} |
7074
| **Attribute** | \`${prop.attr}\` |
7175
| **Type** | \`${prop.type.replace(/\|/g, '\uff5c')}\` |
7276
| **Default** | \`${prop.default}\` |
7377
74-
`
75-
)
76-
.join('\n')}
7778
`;
79+
})
80+
.join('\n')}`;
7881
}
7982

8083
function renderEvents({ events }) {

0 commit comments

Comments
 (0)