docs: better Dark mode explanation

[aversini]

Summary by CodeRabbit

• New Features
  • Added a new focusMode property to enhance component visibility settings, defaulting to match the system's theme.
• Documentation
  • Updated documentation to clarify default mode settings for components.
• Refactor
  • Simplified theme settings by removing redundant mode settings from Button, Table, Footer, and Card components.

[coderabbitai]

Walkthrough

The recent updates focus on refining the dark mode implementation across various components. A notable addition is the focusMode prop, now available in select components with a default setting aligned with the system preferences. Meanwhile, specific mode settings have been removed from the Button, Table, Footer, and Card components, streamlining the approach to theme consistency and simplifying component properties.

Changes

File Path	Changes
.../Styles/DarkMode.stories.tsx	Added focusMode prop with default system to some components, clarified default mode settings, and removed focusMode and mode settings from Button, Table, Footer, and Card components.

---

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-tests 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 tests 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 tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[github-actions]

Bundle Size (components)

Status	File	Size (Gzip)	Limits
✅	style.css	6.42 KB	8 KB
✅	index.js	7.75 KB	20 KB
✅	vendor.js	65.07 KB	67 KB

Overall bundle size: 79.24 KB
Overall status: ✅

Bundle Size (form components)

Status	File	Size (Gzip)	Limits
✅	index.js	4.67 KB (+7 B +0.15%)	20 KB
✅	vendor.js	44.49 KB	67 KB

Overall bundle size: 49.16 KB (+7 B +0.01%)
Overall status: ✅

Bundle Size (system)

Status	File	Size (Gzip)	Limits
✅	style.css	6.7 KB	8 KB
✅	index.js	1.74 KB (-1 B -0.06%)	3 KB
✅	vendor.js	44.49 KB	46 KB

Overall bundle size: 52.93 KB (-1 B 0.00%)
Overall status: ✅

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits

Files that changed from the base of the PR and between 0d416a8 and 919258d.

Files selected for processing (1)

• packages/documentation/src/Styles/DarkMode.stories.tsx (5 hunks)

Additional comments: 4

packages/documentation/src/Styles/DarkMode.stories.tsx (4)

• 55-64: The addition of documentation around the system and alt-system mode props, including the new focusMode prop, is a positive change. It helps clarify how components can automatically switch between dark and light modes based on the user's system preferences or explicitly set modes. This aligns with the PR's objective to enhance the clarity and functionality of dark mode settings.
• 89-91: Clarifying that all components default to system mode, with exceptions for accessibility reasons, is a good practice. It sets clear expectations for the default behavior of components in dark mode. However, ensure that this default behavior is consistently implemented across all components to avoid confusion.
• 127-127: The explicit setting of mode="light" for the Button in the TextInput component is mentioned as an exception to the default system mode for accessibility reasons. This is a good example of how specific cases might require deviation from the default settings to ensure content is accessible. It's important to document these exceptions clearly in the component's documentation to help developers understand when and why they might need to manually set the mode.
• 190-195: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [135-202]

The use of focusMode="alt-system" in the ButtonIcon components within the Table demonstrates the flexibility provided by the new focusMode prop. This allows for more granular control over the appearance of individual components, which can enhance the user experience in complex UIs. However, it's crucial to ensure that the introduction of focusMode does not introduce inconsistencies in the appearance of components across different parts of the application. Consistent testing and documentation will be key to leveraging this new property effectively.