fix: Fixed mdx components have any types instead of their correct types

[MichaelUnkey]

What does this PR do?

Fixes # (issue)

Eng-1258

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• Bug fix (non-breaking change which fixes an issue)
• Chore (refactoring code, technical debt, workflow improvements)
• Enhancement (small improvements)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How should this be tested?

Blog types are working and all images show correctly.

Checklist

Required

• Filled out the "How to test" section in this PR
• Read Contributing Guide
• Self-reviewed my own code
• Commented on my code in hard-to-understand areas
• Ran pnpm build
• Ran pnpm fmt
• Checked for warnings, there are none
• Removed all console.logs
• Merged the latest changes from main onto my branch with git pull origin main
• My changes don't cause any responsiveness issues

Appreciated

• If a UI change was made: Added a screen recording or screenshots to this PR
• Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• ​New Features

  • Introduced enhanced type definitions for components, improving type safety and clarity.

  • Updated image handling to utilize the optimized ImageWithBlur component.

• ​Bug Fixes

  • Corrected SVG attribute names to camelCase for better compatibility with React.

• ​Documentation

  • Improved prop typing for various components, enhancing clarity and usability.

• ​Refactor

  • Restructured component props for better flexibility and handling of optional values.

Summary by CodeRabbit

• New Features

  • Improved type safety in various components, enhancing clarity and usability.
  • Updated image handling in the MdxComponents for better rendering performance.

• Bug Fixes

  • Corrected SVG attribute names to camelCase across multiple components for better compatibility with React.

• Documentation

  • Enhanced type definitions for BlogCodeBlock, BlogImage, BlogList, and BlogQuote components, improving their reusability.

• Refactor

  • Streamlined component structures and props handling in several components for increased flexibility and maintainability.

[linear]

ENG-1258 MDX Components have any types instead of their correct types

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
play	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 11, 2024 4:06pm
www	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 11, 2024 4:06pm

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
dashboard	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 4:06pm
planetfall	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 4:06pm
workflows	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 4:06pm

[changeset-bot]

⚠️ No Changeset found

Latest commit: e7ad2ea

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

Walkthrough

The changes across various files primarily involve the modification of SVG attribute names from kebab-case to camelCase to align with React's JSX syntax. This includes attributes such as fill-rule, clip-rule, and stop-opacity, which have been updated to fillRule, clipRule, and stopOpacity, respectively. Additionally, several components have undergone type definition enhancements for improved type safety and clarity, particularly concerning props in TypeScript. The overall functionality and logic of the components remain unchanged.

Changes

Files	Change Summary
apps/dashboard/app/auth/layout.tsx, apps/dashboard/components/dashboard/command-menu.tsx, apps/dashboard/components/ui/icons.tsx, apps/www/app/accelerate/components/footer-illustration.tsx, apps/www/app/accelerate/components/svg-accelerate-mini.tsx, apps/www/components/analytics/analytics-bento.tsx, apps/www/components/footer/wordmark.tsx, apps/www/components/mdx-content.tsx	Modified SVG attribute names from kebab-case to camelCase (e.g., fill-rule to fillRule, stop-opacity to stopOpacity).
apps/www/components/blog/blog-code-block.tsx	Introduced a new type CodeBlockProps for enhanced type safety and updated the function signature of BlogCodeBlock to utilize this type.
apps/www/components/blog/blog-image.tsx	Restructured props into a new type BlogImageProps, allowing for optional values and conditional rendering based on src and alt properties.
apps/www/components/blog/blog-list.tsx	Added export keyword to BlogListProps type, enhancing its accessibility for imports in other modules.
apps/www/components/blog/blog-quote.tsx	Added export keyword to BlogQuoteProps type, making it publicly accessible for import in other modules.
apps/www/components/image-with-blur.tsx	Changed component declaration from an arrow function to a standard function, modifying the rendering logic based on the fill prop.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant BlogCodeBlock
    participant BlogImage
    participant ImageWithBlur

    User->>BlogCodeBlock: Render with props
    BlogCodeBlock->>BlogImage: Pass props
    BlogImage->>ImageWithBlur: Conditional rendering based on props
    ImageWithBlur->>User: Rendered image output

Loading

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6ce8253 and e7ad2ea.

Files selected for processing (1)

• apps/www/components/mdx-content.tsx (2 hunks)

Additional comments not posted (15)

apps/www/components/mdx-content.tsx (15)

2-4: LGTM!

The imports are necessary for the changes made to the Image and img components in the MdxComponents object.

---

6-6: LGTM!

The imports are necessary for the changes made to the ol, ul, and li components in the MdxComponents object.

---

7-7: LGTM!

The imports are necessary for the changes made to the blockquote and BlogQuote components in the MdxComponents object.

---

12-27: LGTM!

The changes to the Image component in the MdxComponents object are well-implemented and provide several benefits:

• Improved performance and user experience by leveraging the optimizations provided by next/image.
• Enhanced type safety and clarity by using ImageProps instead of any.
• Flexibility in image display through conditional rendering based on width or fill props.
• Placeholder blur effect for a smoother loading experience.

Great work!

---

28-30: LGTM!

The change to the img component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using DetailedHTMLProps and ImgHTMLAttributes. The component correctly renders an img element with the provided src and alt attributes.

---

32-33: LGTM!

The change to the th component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using JSX.IntrinsicAttributes. The component correctly renders a th element with the provided props and applies a specific set of CSS classes for styling.

---

35-37: LGTM!

The change to the tr component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using JSX.IntrinsicAttributes. The component correctly renders a tr element with the provided props and applies a specific set of CSS classes for styling.

---

38-39: LGTM!

The change to the td component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using JSX.IntrinsicAttributes. The component correctly renders a td element with the provided props and applies a specific set of CSS classes for styling.

---

41-46: LGTM!

The change to the a component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using JSX.IntrinsicAttributes. The component correctly renders an a element with the provided props and applies a specific set of CSS classes for styling.

---

48-48: LGTM!

The change to the blockquote component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using BlogQuoteProps. The component correctly renders the BlogQuote component with the provided props.

---

49-49: LGTM!

The change to the BlogQuote component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using BlogQuoteProps. The component correctly renders the BlogQuote component with the provided props.

---

50-50: LGTM!

The change to the ol component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using BlogListProps. The component correctly renders the BlogListNumbered component with the provided props.

---

51-51: LGTM!

The change to the ul component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using BlogListProps. The component correctly renders the BlogList component with the provided props.

---

52-52: LGTM!

The change to the li component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using BlogListProps. The component correctly renders the BlogListItem component with the provided props.

---

59-63: LGTM!

The change to the h2 component in the MdxComponents object improves type safety and clarity by explicitly specifying the expected props using JSX.IntrinsicAttributes. The component correctly renders an h2 element with the provided props and applies a specific set of CSS classes for styling.
[

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Thank you for following the naming conventions for pull request titles! 🙏

[perkinsjr]

The changes to the home pages where you are modifying HTML elements e.g

fill-rull
clip-rule

Breaks the homepage see below:

and

as just some examples. Can you revert those changes so only the MDX components are the only changes?