Skip to content

v2.3.2 - Enhanced Status Elements with Inline Color Syntax

Choose a tag to compare

@JeromeErasmus JeromeErasmus released this 27 Sep 01:23
· 18 commits to main since this release
d80d5ce

πŸŽ‰ Enhanced Status Elements - v2.3.2

✨ Major Enhancement: Inline Color Syntax

We've completely revamped the status element syntax to make it much more user-friendly and intuitive!

πŸ†• New Inline Color Syntax

{status:Complete|color:green}        # Success states
{status:Blocked|color:red}           # Error states  
{status:In Progress|color:yellow}    # Warning states
{status:Available|color:blue}        # Info states
{status:High Priority|color:purple}  # Priority states
{status:Draft|color:neutral}         # Default states

πŸ“Š Practical Examples

# Project Status Dashboard
**Authentication Module**: {status:Complete|color:green}
**Dashboard UI**: {status:In Progress|color:yellow}  
**API Integration**: {status:Blocked|color:red}
**Testing**: {status:Not Started}

## Team Availability
- **Alice Johnson**: {status:Available|color:blue}
- **Bob Smith**: {status:Busy|color:neutral}
- **Carol Davis**: {status:On Vacation|color:purple}

πŸ”„ Migration from Legacy Syntax

# Old syntax (still works for backward compatibility)
<!-- adf:status color="green" -->
{status:Complete}

# New syntax (recommended)
{status:Complete|color:green}

πŸš€ Key Features

  • βœ… User-Friendly: Clean, intuitive inline syntax
  • βœ… Round-Trip Compatible: Perfect Markdown ↔ ADF conversion
  • βœ… Atlassian Compliant: Official ADF specification colors and attributes
  • βœ… Backward Compatible: Legacy {status:text} format still supported
  • βœ… Comprehensive: All 6 official Atlassian status colors supported

🎨 Available Colors

Color Use Case Example
neutral Default, draft states {status:Draft|color:neutral}
green Success, complete, approved {status:Complete|color:green}
red Error, blocked, critical {status:Blocked|color:red}
yellow Warning, in progress, pending {status:In Progress|color:yellow}
blue Information, available, active {status:Available|color:blue}
purple Priority, review, special {status:High Priority|color:purple}

πŸ”§ Technical Improvements

  • Enhanced parsing regex with robust color validation
  • Updated StatusConverter for perfect round-trip conversion
  • Comprehensive test coverage with 42+ status-related tests
  • Full documentation updates across all user guides

πŸ“š Updated Documentation

  • Enhanced quick-start guide with practical examples
  • Updated markdown-to-adf conversion documentation
  • Comprehensive element specifications with migration guide
  • All examples updated to showcase new syntax

πŸ§ͺ Quality Assurance

  • All status-related tests passing (42 tests)
  • Round-trip conversion validated
  • Integration with tables, panels, and mixed content verified
  • Backward compatibility maintained and tested

Upgrade today to enjoy the much more intuitive status element syntax while maintaining full compatibility with existing documents!