fix: Border param not working for StacTable

[Potatomonsta]

Description

Table 'TableBorder' is not being applied

Additional Context

Border is being instantiated with default values in json

[coderabbitai]

📝 CodeRabbit Plan Mode

Generate an implementation plan and prompts that you can use with your favorite coding agent.

✅ Successfully generated implementation plan.

💡 Use @coderabbitai <feedback> to replan

Examples

• Example 1
• Example 2

---

🧪 Issue enrichment is currently in open beta.

You can configure auto-planning by selecting labels in the issue_enrichment configuration.

To disable automatic issue enrichment, add the following to your .coderabbit.yaml:

issue_enrichment:
  auto_enrich:
    enabled: false

💬 Have feedback or questions? Drop into our discord!

[coderabbitai]

Coding Plan

Approach

Enable proper border rendering for StacTable by migrating from the limited StacTableBorder model to StacBorder, which supports both uniform and per-side border customization as documented.

Observations

The STAC framework separates models (stac_framework) from parsers (stac). Border handling uses StacBorder for general borders with per-side support, while StacTableBorder was a simplified uniform-only variant. The framework uses json_serializable for JSON deserialization and parser extensions that convert models to Flutter widgets. Documentation shows table borders should support per-side customization, but the current implementation only handles uniform borders.

Assumptions

Assumption 1: What should be the migration strategy for the border field type?

Options Considered:

• Change directly to StacBorder? and deprecate StacTableBorder
• Accept both types with conditional handling
• Create a new separate field for advanced borders

Chosen Option: 1

Rationale: Direct migration to StacBorder? provides the cleanest architecture, aligns with documentation, and StacBorder's uniform properties maintain backward compatibility for simple borders.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Update StacTable Model

Update the StacTable model to use StacBorder instead of StacTableBorder, enabling both uniform and per-side border customization.

Task 1: Modify StacTable border field type

Update the border field definition in the StacTable model class.

• Locate the StacTable model class in packages/stac_framework/lib/src/widgets/ (or similar widgets directory)
• Change the border field type from StacTableBorder? to StacBorder?
• Ensure the field maintains its optional nullable type
• Verify @JsonSerializable() annotation is present on the class
• Update any related documentation comments to reflect per-side border support

Task 2: Regenerate JSON serialization code

Run code generation to update the .g.dart file with correct StacBorder deserialization.

• Execute flutter pub run build_runner build --delete-conflicting-outputs in the stac_framework package directory
• Verify the generated .g.dart file correctly calls StacBorder.fromJson() for the border field
• Confirm the generated code handles null border values appropriately

🤖 Prompt for AI agents

Update the StacTable model to use StacBorder instead of StacTableBorder for
proper border rendering support.

In the StacTable model class:
- Change the border field type from `StacTableBorder?` to `StacBorder?`
- Update documentation comments to reflect per-side border support
- Regenerate JSON serialization code using build_runner

Phase 2: Update Border Parser

Replace StacTableBorderParser with a parser extension on StacBorder that converts to Flutter's TableBorder with full per-side support.

Task 1: Create StacBorderTableParser extension

Add a new parser method to convert StacBorder to Flutter TableBorder with per-side customization.

• Create parser extension in packages/stac/lib/src/parsers/foundation/ui_components/ directory
• Add parseTableBorder() method on StacBorder that returns Flutter's TableBorder
• Handle uniform borders: When only global properties (color, width, borderStyle) are set, use TableBorder.all()
• Handle per-side borders: When individual sides (top, right, bottom, left) are set, use TableBorder() constructor with each BorderSide
• Map horizontalInside and verticalInside from the vertical/horizontal StacBorderSide properties if available, or use uniform properties as fallback
• Apply default values only when properties are null: color defaults to Colors.black, width to 1.0, style to BorderStyle.solid

Task 2: Update StacTableParser to use new border conversion

Modify the table parser to call the new StacBorder parsing method.

• Update packages/stac/lib/src/parsers/widgets/stac_table/stac_table_parser.dart
• Replace StacTableBorderParser(model.border!).parse(context) with model.border?.parseTableBorder(context)
• Use null-aware operator to handle cases where border is not specified
• Ensure the returned TableBorder is passed to Flutter's Table widget correctly

Task 3: Deprecate StacTableBorder and its parser

Mark the old border classes as deprecated since StacBorder now handles all table border needs.

• Add @Deprecated('Use StacBorder instead') annotation to StacTableBorder class in packages/stac_core/lib/foundation/borders/stac_table_border/
• Add @Deprecated('Use StacBorder.parseTableBorder() instead') to StacTableBorderParser extension
• Add deprecation comments explaining the migration path to StacBorder

🤖 Prompt for AI agents

Implement a new parser extension for StacBorder to convert to Flutter's
TableBorder, and migrate StacTableParser to use it.

Create StacBorderTableParser extension:
- Add `parseTableBorder()` method on StacBorder returning Flutter TableBorder
- For uniform borders (only global properties set), use `TableBorder.all()`
- For per-side borders (individual sides set), use `TableBorder()` constructor
with each BorderSide
- Map horizontalInside and verticalInside from vertical/horizontal properties
with uniform fallback
- Apply defaults: color=Colors.black, width=1.0, style=BorderStyle.solid

Update StacTableParser:
- Replace StacTableBorderParser calls with
`model.border?.parseTableBorder(context)`

Deprecate old classes:
- Add @Deprecated annotations to StacTableBorder and StacTableBorderParser
- Include migration path comments

Phase 3: Update Documentation and Examples

Ensure examples and documentation reflect the correct border usage pattern.

Task 1: Verify example JSON configurations

Check that existing table examples work with the updated border model.

• Review examples/stac_gallery/assets/json/table_example.json
• Confirm existing uniform border JSON ({"color": "#000000", "width": 1.0}) deserializes correctly as StacBorder with uniform properties
• Test that per-side border examples from documentation ({"top": {...}, "right": {...}}) now work properly
• Add an additional example demonstrating per-side table border customization if not present

Task 2: Update documentation examples

Ensure documentation accurately reflects the StacBorder usage for tables.

• Review docs/widgets/table.mdx for accuracy
• Confirm documented border examples align with StacBorder JSON structure
• Update any references to StacTableBorder to mention StacBorder instead
• Clarify that both uniform and per-side border configurations are supported

🤖 Prompt for AI agents

Update examples and documentation to reflect StacBorder usage for tables.

Verify example JSON configurations:
- Ensure existing uniform border JSON deserializes correctly as StacBorder
- Test per-side border examples work properly
- Add per-side table border customization example if missing

Update documentation:
- Review table documentation for accuracy
- Replace StacTableBorder references with StacBorder
- Clarify support for both uniform and per-side configurations

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Update the StacTable model to use StacBorder instead of StacTableBorder for
proper border rendering support.

In the StacTable model class:
- Change the border field type from `StacTableBorder?` to `StacBorder?`
- Update documentation comments to reflect per-side border support
- Regenerate JSON serialization code using build_runner
===============================================================================

Task: 2

Implement a new parser extension for StacBorder to convert to Flutter's
TableBorder, and migrate StacTableParser to use it.

Create StacBorderTableParser extension:
- Add `parseTableBorder()` method on StacBorder returning Flutter TableBorder
- For uniform borders (only global properties set), use `TableBorder.all()`
- For per-side borders (individual sides set), use `TableBorder()` constructor
with each BorderSide
- Map horizontalInside and verticalInside from vertical/horizontal properties
with uniform fallback
- Apply defaults: color=Colors.black, width=1.0, style=BorderStyle.solid

Update StacTableParser:
- Replace StacTableBorderParser calls with
`model.border?.parseTableBorder(context)`

Deprecate old classes:
- Add @Deprecated annotations to StacTableBorder and StacTableBorderParser
- Include migration path comments
===============================================================================

Task: 3

Update examples and documentation to reflect StacBorder usage for tables.

Verify example JSON configurations:
- Ensure existing uniform border JSON deserializes correctly as StacBorder
- Test per-side border examples work properly
- Add per-side table border customization example if missing

Update documentation:
- Review table documentation for accuracy
- Replace StacTableBorder references with StacBorder
- Clarify support for both uniform and per-side configurations

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- @coderabbitai You can skip phase 3. Add a simple unit test case for phase 2.
- @coderabbitai For assumption 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[divyanshub024]

Hey @Potatomonsta, this is not an issue with table_border itself. The problem is in the documentation. The border schema defined in the table docs is incorrect. I will send a fix for the docs shortly.