Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: '21.x'
node-version-file: '.nvmrc'

- name: 📦 Install
run: npm install
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Prefix the change with one of these keywords:

## [Unreleased]

### Added

- New campaign banner component that replaces funding details

## [0.29.0]

### Changed
Expand Down
4 changes: 1 addition & 3 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,7 @@ export default defineConfig({
fileName: (format) => `rds.${format}.js`,
},
rollupOptions: {
external: [
/* all dependencies externalized */
],
external: [/* all dependencies externalized */],
output: {
globals: {
react: 'React',
Expand Down
149 changes: 79 additions & 70 deletions docs/COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,12 @@ import { Alert } from '@carletonuniversity/rds'
```

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `type` | `'success' \| 'warning' \| 'error' \| 'info'` | `'info'` | Alert style variant |
| `title` | `string` | - | Alert heading |
| `children` | `ReactNode` | - | Alert content |

| Prop | Type | Default | Description |
| ---------- | --------------------------------------------- | -------- | ------------------- |
| `type` | `'success' \| 'warning' \| 'error' \| 'info'` | `'info'` | Alert style variant |
| `title` | `string` | - | Alert heading |
| `children` | `ReactNode` | - | Alert content |

---

Expand All @@ -72,12 +73,13 @@ import { Avatar } from '@carletonuniversity/rds'
```

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `src` | `string` | - | Image URL |
| `alt` | `string` | - | Alt text |
| `initials` | `string` | - | Fallback initials |
| `size` | `'sm' \| 'md' \| 'lg'` | `'md'` | Avatar size |

| Prop | Type | Default | Description |
| ---------- | ---------------------- | ------- | ----------------- |
| `src` | `string` | - | Image URL |
| `alt` | `string` | - | Alt text |
| `initials` | `string` | - | Fallback initials |
| `size` | `'sm' \| 'md' \| 'lg'` | `'md'` | Avatar size |

---

Expand All @@ -99,10 +101,11 @@ import { Badge, BadgeGroup } from '@carletonuniversity/rds'
```

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `color` | `'red' \| 'grey' \| 'green' \| 'blue'` | `'grey'` | Badge color |
| `children` | `ReactNode` | - | Badge content |

| Prop | Type | Default | Description |
| ---------- | -------------------------------------- | -------- | ------------- |
| `color` | `'red' \| 'grey' \| 'green' \| 'blue'` | `'grey'` | Badge color |
| `children` | `ReactNode` | - | Badge content |

---

Expand Down Expand Up @@ -134,13 +137,14 @@ import { Button, ButtonGroup } from '@carletonuniversity/rds'
```

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `color` | `'red' \| 'grey' \| 'dark-grey' \| 'black' \| 'white'` | `'red'` | Button color |
| `type` | `'button' \| 'submit' \| 'reset'` | `'button'` | Button type |
| `isSmall` | `boolean` | `false` | Small size variant |
| `isFull` | `boolean` | `false` | Full width |
| `isDisabled` | `boolean` | `false` | Disabled state |

| Prop | Type | Default | Description |
| ------------ | ------------------------------------------------------ | ---------- | ------------------ |
| `color` | `'red' \| 'grey' \| 'dark-grey' \| 'black' \| 'white'` | `'red'` | Button color |
| `type` | `'button' \| 'submit' \| 'reset'` | `'button'` | Button type |
| `isSmall` | `boolean` | `false` | Small size variant |
| `isFull` | `boolean` | `false` | Full width |
| `isDisabled` | `boolean` | `false` | Disabled state |

---

Expand Down Expand Up @@ -192,22 +196,23 @@ import { Card } from '@carletonuniversity/rds'
```

**Subcomponents:**
| Component | Description |
|-----------|-------------|
| `Card.Figure` | Image container |
| `Card.ImageThumb` | Small image thumbnail |
| `Card.DateThumb` | Date display thumbnail |
| `Card.IconThumb` | Icon thumbnail |
| `Card.Initials` | Initials avatar |
| `Card.Video` | Video embed |
| `Card.Header` | Title and subtitle |
| `Card.Body` | Content wrapper |
| `Card.Content` | Main content area |
| `Card.Footer` | Footer actions |
| `Card.Excerpt` | Brief text excerpt |
| `Card.EventMeta` | Event metadata |
| `Card.PeopleMeta` | Person metadata |
| `Card.Stats` | Statistics display |

| Component | Description |
| ----------------- | ---------------------- |
| `Card.Figure` | Image container |
| `Card.ImageThumb` | Small image thumbnail |
| `Card.DateThumb` | Date display thumbnail |
| `Card.IconThumb` | Icon thumbnail |
| `Card.Initials` | Initials avatar |
| `Card.Video` | Video embed |
| `Card.Header` | Title and subtitle |
| `Card.Body` | Content wrapper |
| `Card.Content` | Main content area |
| `Card.Footer` | Footer actions |
| `Card.Excerpt` | Brief text excerpt |
| `Card.EventMeta` | Event metadata |
| `Card.PeopleMeta` | Person metadata |
| `Card.Stats` | Statistics display |

---

Expand All @@ -229,18 +234,19 @@ import { Listing } from '@carletonuniversity/rds'
```

**Subcomponents:**
| Component | Description |
|-----------|-------------|
| `Listing.Figure` | Image container |
| `Listing.DateThumb` | Date thumbnail |
| `Listing.IconThumb` | Icon thumbnail |
| `Listing.Initials` | Initials avatar |
| `Listing.Header` | Title area |
| `Listing.Body` | Content wrapper |
| `Listing.Content` | Main content |
| `Listing.Footer` | Footer area |
| `Listing.Excerpt` | Text excerpt |
| `Listing.EventMeta` | Event metadata |

| Component | Description |
| -------------------- | --------------- |
| `Listing.Figure` | Image container |
| `Listing.DateThumb` | Date thumbnail |
| `Listing.IconThumb` | Icon thumbnail |
| `Listing.Initials` | Initials avatar |
| `Listing.Header` | Title area |
| `Listing.Body` | Content wrapper |
| `Listing.Content` | Main content |
| `Listing.Footer` | Footer area |
| `Listing.Excerpt` | Text excerpt |
| `Listing.EventMeta` | Event metadata |
| `Listing.PeopleMeta` | Person metadata |

---
Expand Down Expand Up @@ -315,10 +321,11 @@ import { Icon } from '@carletonuniversity/rds'
```

**Props:**
| Prop | Type | Default | Description |
|------|------|---------|-------------|
| `icon` | `string` | - | Font Awesome class |
| `size` | `number \| string` | - | Icon size (4-24) |

| Prop | Type | Default | Description |
| ------ | ------------------ | ------- | ------------------ |
| `icon` | `string` | - | Font Awesome class |
| `size` | `number \| string` | - | Icon size (4-24) |

---

Expand Down Expand Up @@ -393,12 +400,13 @@ import { Splash } from '@carletonuniversity/rds'
```

**Subcomponents:**
| Component | Description |
|-----------|-------------|

| Component | Description |
| ------------------- | -------------------- |
| `Splash.Background` | Background container |
| `Splash.Video` | Background video |
| `Splash.Image` | Background image |
| `Splash.Content` | Overlay content |
| `Splash.Video` | Background video |
| `Splash.Image` | Background image |
| `Splash.Content` | Overlay content |

---

Expand Down Expand Up @@ -518,17 +526,18 @@ import { Nav } from '@carletonuniversity/rds'
```

**Subcomponents:**
| Component | Description |
|-----------|-------------|
| `Nav.Top` | Top navigation bar |
| `Nav.Bottom` | Main navigation bar |
| `Nav.Aside` | Sidebar navigation |
| `Nav.Menu` | Menu container |
| `Nav.SubMenu` | Dropdown submenu |
| `Nav.MenuItem` | Menu item |
| `Nav.MenuItemWrapper` | Menu item wrapper |
| `Nav.Logo` | Logo component |
| `Nav.Buttons` | Button group |

| Component | Description |
| --------------------- | ------------------- |
| `Nav.Top` | Top navigation bar |
| `Nav.Bottom` | Main navigation bar |
| `Nav.Aside` | Sidebar navigation |
| `Nav.Menu` | Menu container |
| `Nav.SubMenu` | Dropdown submenu |
| `Nav.MenuItem` | Menu item |
| `Nav.MenuItemWrapper` | Menu item wrapper |
| `Nav.Logo` | Logo component |
| `Nav.Buttons` | Button group |

---

Expand Down
Loading
Loading