Mark deprecated props/events/methods

easyops-cn · Jan 25, 2024 · aa2edc0 · aa2edc0
1 parent 33a327b
commit aa2edc0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/src/components/BrickDocEvents/index.tsx b/src/components/BrickDocEvents/index.tsx
@@ -27,7 +27,15 @@ export default function BrickDocEvents({
         {events.map((event) => (
           <tr key={event.name}>
             <td>
-              <code>{event.name}</code>
+              <code
+                title={
+                  typeof event.deprecated === "string"
+                    ? event.deprecated
+                    : undefined
+                }
+              >
+                {event.deprecated ? <del>{event.name}</del> : event.name}
+              </code>
             </td>
             <td>{event.description}</td>
             <td>

diff --git a/src/components/BrickDocMethods/index.tsx b/src/components/BrickDocMethods/index.tsx
@@ -35,7 +35,15 @@ export default function BrickDocMethods({
         {methods.map((method) => (
           <tr key={method.name}>
             <td>
-              <code>{method.name}</code>
+              <code
+                title={
+                  typeof method.deprecated === "string"
+                    ? method.deprecated
+                    : undefined
+                }
+              >
+                {method.deprecated ? <del>{method.name}</del> : method.name}
+              </code>
             </td>
             <td>{method.description}</td>
             <td>

diff --git a/src/components/BrickDocProperties/index.tsx b/src/components/BrickDocProperties/index.tsx
@@ -27,7 +27,15 @@ export default function BrickDocProperties({
         {properties.map((prop) => (
           <tr key={prop.name}>
             <td>
-              <code>{prop.name}</code>
+              <code
+                title={
+                  typeof prop.deprecated === "string"
+                    ? prop.deprecated
+                    : undefined
+                }
+              >
+                {prop.deprecated ? <del>{prop.name}</del> : prop.name}
+              </code>
             </td>
             <td>{prop.description}</td>
             <td>