canonrs-server 0.1.0

CanonRS server-side rendering support
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# Banner

## Overview

### What it is
Banner is a feedback component used to display persistent, page-level messages in CanonRS. It provides a structured and accessible way to communicate important information to users across an entire interface.

It supports composability and controlled visibility, ensuring consistent behavior across different contexts.

### The problem it solves
Traditional banners often lack consistent accessibility semantics and visibility control. Developers rely on ad hoc logic, leading to inconsistent behavior and poor user experience.

Banner solves this by enforcing visibility and accessibility through structured primitives and state encoding.

### How CanonRS enforces it
BannerVariant defines semantic meaning and ARIA behavior, while VisibilityState ensures correct open and hidden states without runtime logic. This guarantees consistent rendering and accessibility.

## Usage

### Basic usage
```rust
view! {
  <Banner>
    <BannerContent>"Message"</BannerContent>
  </Banner>
}
```

### With variants
Variants define the tone and semantic meaning of the banner.

### With sizes
No size variants are defined.

### With states
Visibility is controlled internally, ensuring consistent behavior without manual toggling.

### Composition patterns
Banner supports content, actions, and close controls, enabling flexible layouts.

## Variants

### Info
Used for informational messages.

### Warning
Used for cautionary messages.

### Destructive
Used for critical alerts.

## Sizes

### Default
Inherited from layout.

## States

### Visible
Banner is displayed and announced correctly.

### Hidden
Banner is not rendered or is visually hidden.

## API Reference

### Props
- variant: BannerVariant
- class: String

### Types
- BannerVariant

## Governance

### Canon Rules applied
CR-001, CR-004

### What the compiler enforces
Correct structure and accessibility semantics.

### Before vs After
Before: inconsistent banner implementations.  
After: structured and accessible banners.

## Use Cases

### System announcements
Used to communicate updates or maintenance.

### Warnings
Used to highlight important notices.

## Related Components

### Alert
Use Alert for localized messages.

### Toast
Use Toast for transient notifications.