Table caption support #1057
Table caption support #1057
Conversation
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1057 +/- ##
==========================================
- Coverage 84.09% 84.09% -0.01%
==========================================
Files 1146 1146
Lines 20946 20951 +5
Branches 7922 7927 +5
==========================================
+ Hits 17615 17619 +4
- Misses 3243 3244 +1
Partials 88 88 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![factory-droid[bot]](https://avatars.githubusercontent.com/in/358017?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Description:
This PR implements table caption support using the HTML native element to improve accessibility. It adds three new props (caption, captionClassName, captionSide) with TypeScript definitions and documentation, includes necessary styling changes, and adds demonstration stories for both top and bottom caption positioning. 1
Click For Summary of Files
Summary of Files
Files Modified
src/components/Table/Internal/octable.module.scss
Added base styling support for table captions:
- Introduced table-caption CSS class with hidden visibility, laying groundwork for the new caption feature that will improve table accessibility
src/components/Table/Internal/OcTable.tsx
Added table caption support with configurable positioning:
- Implemented native HTML caption element with customizable styling and positioning
- Added support for caption text, custom className, and position control (top/bottom)
- Integrated caption rendering for both standard and fixed-header table variants
src/components/Table/Internal/OcTable.types.ts
Added table caption support with accessibility features:
- Implemented three new table props:
- caption for rendering content in native HTML caption element
- captionClassName for custom styling
- captionSide for controlling caption position (top/bottom)
src/components/Table/Table.stories.tsx
Added story examples for new Table caption feature:
- Created two new stories demonstrating caption functionality (default top position and bottom position)
- Added story configurations with sample caption text and positioning options
- Updated named exports order to include new caption stories in proper sequence
Tips
Review Droid is highly customizable and comes with powerful features for augmenting your organization's code review process. Here are some tips to get the most out of it.
Table of contents
- Droid Fill - Contextual PR Body Replacement
- Review Guidelines - Creating guidelines for Droid to enforce
- Droid Chat - Follow up with Droid's Comments
- PR Healing - Diagnose & Fix Failures in CI
- Teaching Droid - Giving Droid feedback so it learns
- Review Usage
⌨️ Droid Fill
Contextual PR Body Replacement
When you create a PR with the @droid fill command anywhere in your PR body, Review Droid will fill in the PR description for your pull request based on it's PR analysis. This will also take into account your pull request templates.
Review Droid can also analyze your project management system. If you have a project management system integrated with Factory (e.g. Linear, Jira) Review Droid will also integrate information from linked and related tickets.
At Factory, we typically create our PR's with this command. For example, let's say I'm creating a PR which addresses the jira ticket FAC-123. I would write the following PR description:
@droid fill FAC-123
and your Review Droid fills in the rest!
📚 Review Guidelines
Creating guidelines for Droid to follow
You can configure guidelines that Droid will follow when reviewing your PRs. Droid will focus on these aspects of your code and aim to leave in-line comments if any guidelines are violated.
Guidelines are defined in your repository's .droid.yaml. Every week, Droid will automatically refine and edit these guidelines based on the feedback you leave on Droid's comments.
💬 Droid Chat
Ask questions on a PR
You can leave in-line comments on PR's by tagging @droid in-line. This can be helpful when reviewing other's PRs. Some examples include:
@droid this section looks sketchy, are there issues with it?@droid can you show me some examples of what this regex matches?@droid is this the most efficient way to do this? I'm concerned about performance.
Follow up with Review Droid's Comments
You can reply to Review Droid's in-line review comments directly to ask questions or provide feedback. Some examples include:
@droid I made the change you suggested, does that fix the issue?@droid we don't actually need to do this because of X, Y, Z. Can you confirm?@droid do we have any scripts that rely on this behavior?
🛠️ PR Healing
Diagnose & Fix Failures in CI
Review Droid is aware of the CI processes you utilize and proposes fixes in case of any failures. This allows it to promptly address issues in your pull requests before they escalate.
By default, PR Healing is activated. Your organization does not have advanced PR healing enabled, which involved Review Droid directly making a PR to your PR which fixes the issue. If you would like to enable this feature, you must have an Enterprise Plan.
🎓 Teaching Droid
Giving Droid feedback so it learns
You can give feedback to Review Droid by replying or reacting to its comments (👍 / 👎). This helps Review Droid learn from your preferences and improve its future reviews.
To send feedback directly to the Factory team, include @droid feedback in your comment. Droid will file a ticket with your feedback and provide a ticket ID so you can track it with our support team.
🔎 Review Usage
Re-Requesting Review
If you make changes to your PR and want Review Droid to re-review it, you can simply comment @droid review on the PR. This will trigger Droid to re-review the PR and update the review body.
.droid.yaml to Configure Review Droid
You can place a .droid.yaml file in the root of your repository. This file contains settings for a variety of features and settings including:
- Guidelines - For defining the rules that Review Droid will enforce
- Enabling/Disabling Per-file Summaries
- Enabling/Disabling PR Healing
- Path Filters (For ignoring certain files or directories)
- Auto-Review Settings
- Chat settings
To override a setting leave a comment on a PR with the setting to disable/enable/reset. For example @droid setting disable progress_comment. The current options are: progress_comment, lgtm_comment, and list.
list is a special setting that will list all the settings that you have set and will explain what each setting does.
For more information, you can view our documentation at https://docs.factory.ai - the password is factory.
Ignoring Reviews
If you want to have your PR ignored by Review Droid you can define Droid Ignored Title Words in your .droid.yaml file. If the title of your PR contains any of these words, Review Droid will ignore the PR.
Your organization currently has the following words in the Droid Ignored Title Words list:
None
Footnotes
-
React 👍 / 👎 to comments you like / dislike. Droid will learn from this feedback to leave better reviews. My in-line comments are based on your review guidelines. If you have any questions about the comments, reply to them with @droid ↩
| /** | ||
| * The Table caption position. | ||
| * @default 'top' | ||
| */ | ||
| captionSide?: 'top' | 'bottom'; |
There was a problem hiding this comment.
1 Use an enum for the caption positioning options instead of a union type. Caption positioning represents component variants and should follow the established pattern.
export enum TableCaptionSide {
Top = 'top',
Bottom = 'bottom'
}Then update the interface:
/**
* The Table caption position.
* @default TableCaptionSide.Top
*/
captionSide?: TableCaptionSide;Also update the default parameter in OcTable.tsx to use TableCaptionSide.Top.
Footnotes
-
This suggestion is based on your review guideline: "Use interfaces for component props. Prefer enums for component variants, modes, and sizes. Export all types and interfaces. Use descriptive names for types and interfaces. Use proper JSDoc comments to document types. Follow TypeScript best practices for unions, intersections, and optional properties. Use generics to create flexible, reusable types. Avoid circular type dependencies. Use type aliases for complex union or intersection types. Ensure consistent naming conventions across type definitions.
" ↩
| &-caption { | ||
| visibility: hidden; | ||
| } |
There was a problem hiding this comment.
1 Remove the visibility: hidden property from the caption styling. Table captions should be visible by default when provided, especially since this feature is being added for accessibility purposes. The current CSS rule would hide all captions, defeating the purpose of the caption functionality.
Committable suggestion
Please carefully review the code before committing.
| &-caption { | |
| visibility: hidden; | |
| } | |
| &-caption { | |
| } |
Footnotes
-
This suggestion is based on your review guideline: "Catch and correct any obvious bugs. Ensure code is clean, maintainable, and follows project conventions. Check for security vulnerabilities and performance issues. Avoid circular dependencies.
" ↩
SUMMARY:
Add support for table caption
GITHUB ISSUE (Open Source Contributors)
JIRA TASK (Eightfold Employees Only):
CHANGE TYPE:
TEST COVERAGE:
TEST PLAN: