Skip to content

DRAFT: Update details box. #1636

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DRAFT: Update details box. #1636

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0250936
Update details box.
bgravenorst Oct 16, 2024
5fd7e43
Remove line.
bgravenorst Oct 16, 2024
fb4de64
Merge branch 'main' into updateDetailsBox
joaniekube Oct 21, 2024
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
3 changes: 2 additions & 1 deletion src/components/ParserOpenRPC/DetailsBox/RenderParams.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,9 @@ export const renderParamSchemas = (inputSchema, schemas) => {
<>
{inputSchema.map((item, i) => {
return (
<div key={`${i}`} className={styles.borderTopLine}>
<div key={`${i}`}>
{renderSchema(item, schemas, item.name)}
{i < inputSchema.length - 1 && <hr className={styles.paramSeparator} />}
</div>
);
})}
Expand Down
41 changes: 26 additions & 15 deletions src/components/ParserOpenRPC/DetailsBox/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,19 @@ export default function DetailsBox({
)}
<Heading as="h1">{method}</Heading>
{summary !== null && (
<p style={{ marginBottom: "0.5rem" }}>
<p style={{ marginBottom: "0.5rem" }}
className={clsx("padding-bottom--md", styles.borderBottomLine)}
>
<strong>Summary: </strong>
<MDContent content={summary} />
<span className={styles.summaryText}>
<MDContent content={summary} />
</span>
</p>
)}
{description !== null && (
<MDContent content={description} />
<div className="padding-top--lg">
<MDContent content={description} />
</div>
)}
{extraContent && <div className="padding-top--lg">{extraContent}</div>}
<Heading
Expand All @@ -67,27 +73,32 @@ export default function DetailsBox({
>
Parameters
</Heading>
{params.length === 0 ? (
<div>This method does not accept any parameters</div>
) : (
<>{params && renderParamSchemas(params, components)}</>
)}
<div className={styles.paramContainer}>
{params.length === 0 ? (
<div className="padding-vert--md">
This method doesn't accept any parameters.
</div>
) : (
params && renderParamSchemas(params, components)
)}
</div>
<Heading
as="h2"
className={clsx(
styles.secondaryHeading,
styles.borderBottomLine,
"padding-top--lg padding-vert--md",
)}
>
Returns
</Heading>
{result?.description && (
<div className="padding-vert--md">
<MDContent content={result.description} />
</div>
)}
{result && renderResultSchemas(result, components)}
<div className={styles.paramContainer}>
{result?.description && (
<div className="padding-vert--md">
<MDContent content={result.description} />
</div>
)}
{result && renderResultSchemas(result, components)}
</div>
</>
);
}
20 changes: 20 additions & 0 deletions src/components/ParserOpenRPC/DetailsBox/styles.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,23 @@
border-radius: 6px;
background-color: #ffcdd2;
}

.summaryText {
font-style: italic;
color: #6a737d;
font-weight: 400;
}

.paramContainer {
border: 1px solid #848c96;
border-radius: 8px;
padding: 1rem;
margin-top: 1rem;
}

.paramSeparator {
border: 0;
border-top: 1px solid #848c96;
margin: 1rem 0;
width: 100%;
}
Loading