Skip to content

Display a placeholder in the API reference if availability data is missing #190

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
rdw-software merged 2 commits into from
Feb 17, 2025
Merged

Display a placeholder in the API reference if availability data is missing #190

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b7953a
UI: Fix invisible function tables without a since tag
rdw-software Feb 17, 2025
55a5f9b
API: Validate Function blocks to find missing props
rdw-software Feb 17, 2025
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
42 changes: 35 additions & 7 deletions src/components/API/API.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,40 @@ import React from "react";

import styles from "./styles.module.css";

export const Function = ({ since, children }) =>
(since && (
<>
<span className={styles.sinceBlock}>Available since: {since}</span>
<div className={styles.function}>{children}</div>
</>
)) || <></>;
class Function extends React.Component {
render() {
const since = this.props.since;
const children = this.props.children;

const isRunningInDevelopmentMode = process.env.NODE_ENV !== "production";
if (isRunningInDevelopmentMode) {
// Doesn't look like more context can easily be obtained, so let's leave it at that...
const where = location;
const what = `Missing property (since) for (Function) imported from ${where}`;
const message = `${what}`;
if (!since) throw new Error(message);
}

const sinceBlock = (since && (
<>
<span className={styles.sinceBlock}>Available since: {since}</span>
</>
)) || (
<>
<span className={styles.sinceBlock}>
Available since: ¯\_(ツ)_/¯ (Missing availability data - sorry about
that)
</span>
</>
);
return (
<>
{sinceBlock}
<div className={styles.function}>{children}</div>
</>
);
}
}

class NilableInfo extends React.Component {
render() {
Expand Down Expand Up @@ -346,6 +373,7 @@ class Blocking extends React.Component {
}

export {
Function,
Parameters,
Parameter,
Returns,
Expand Down