Skip to content
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.

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

feat(docs): update callouts to include icon attribute #1597

Merged
merged 3 commits into from
Oct 4, 2024

Conversation

chdeskur
Copy link
Contributor

@chdeskur chdeskur commented Oct 4, 2024

This PR adds the icon attribute to the Callout options so that custom icons can be used in the various Callout-styled components.

The example below tests the PR using a custom icon with the components

Screenshot 2024-10-04 at 9 55 33 AM

Copy link

github-actions bot commented Oct 4, 2024

Playwright test results

passed  1 passed

Details

stats  1 test across 1 suite
duration  9 seconds
commit  0fe07b1

Copy link

github-actions bot commented Oct 4, 2024

PR Preview

Copy link

github-actions bot commented Oct 4, 2024

📦 Next.js Bundle Analysis for fern-platform-monorepo

This analysis was generated by the Next.js Bundle Analysis action. 🤖

🎉 Global Bundle Size Decreased

Page Size (compressed)
global 241.2 KB (🟢 -16.08 KB)
Details

The global bundle is the javascript bundle that loads alongside every page. It is in its own category because its impact is much higher - an increase to its size means that every page on your website loads slower, and a decrease means every page loads faster.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

If you want further insight into what is behind the changes, give @next/bundle-analyzer a try!

New Page Added

The following page was added to the bundle from the code in this PR:

Page Size (compressed) First Load % of Budget (350 KB)
/404 447 B 241.63 KB 69.04%

Two Pages Changed Size

The following pages changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load % of Budget (350 KB)
/dynamic/[host]/[[...slug]] 55.6 KB 296.79 KB 84.80% (🟢 -6.15%)
/static/[host]/[[...slug]] 55.6 KB 296.79 KB 84.80% (🟢 -6.15%)
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

The "Budget %" column shows what percentage of your performance budget the First Load total takes up. For example, if your budget was 100kb, and a given page's first load size was 10kb, it would be 10% of your budget. You can also see how much this has increased or decreased compared to the base branch of your PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this. If you see "+/- <0.01%" it means that there was a change in bundle size, but it is a trivial enough amount that it can be ignored.

Copy link

github-actions bot commented Oct 4, 2024

Playwright test results

passed  81 passed

Details

stats  81 tests across 3 suites
duration  1 minute, 25 seconds
commit  0fe07b1

@@ -101,65 +101,85 @@ export const Callout: FC<PropsWithChildren<Callout.Props>> = ({ intent: intentRa

// aliases

export function InfoCallout({ children, title }: PropsWithChildren<Omit<Callout.Props, "intent">>): ReactElement {
export function InfoCallout({ children, title, icon }: PropsWithChildren<Omit<Callout.Props, "intent">>): ReactElement {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can also just spread the props in case new props are ever added in the future

change { children, title, icon } to { children, ...props }

<Callout intent="info" {...props}>
  {children}
</Callout>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants