Skip to content

Commit 9ae7a68

Browse files
committed
docs: finalize README and component documentation with new features and stories
1 parent 183b5f2 commit 9ae7a68

3 files changed

Lines changed: 20 additions & 12 deletions

File tree

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,41 +42,47 @@ export default function App() {
4242

4343
## Features
4444

45-
- **Header** with 5 scroll behaviors: `fixed`, `static`, `reveal-all`, `reveal-nav`, `reveal-context`, `reveal-search`
45+
- **Header** with 7 scroll behaviors: `fixed`, `static`, `sticky`, `reveal-all`, `reveal-nav`, `reveal-context`, `reveal-search`
46+
- **Animation Speed** control: `slow`, `normal`, `fast` durations for all transitions
4647
- **Footer** with 3 variants: `tab-bar`, `floating`, `mini`
4748
- **Auto-hide** footer behavior tied to scroll direction
49+
- **Sticky Sub-navigation** support via dynamic `--header-height` CSS variable
4850
- **SafeArea** for mobile notch/gesture-bar insets
49-
- **Dark, light, and primary** header themes
51+
- **Dark, light, and primary** header themes + `none` for custom styling
5052
- **Mobile menu** support with animated drawer
5153
- **Framer Motion** powered animations
52-
- **Tailwind CSS v4** styling with full customization
54+
- **Tailwind CSS v4** styling with standard shadcn/ui tokens
5355
- **SSR-safe** with `"use client"` directives
54-
- **Fully typed** with exported TypeScript types
56+
- **Interactive Documentation** with live Storybook previews
5557

5658
## Components
5759

5860
| Component | Description |
5961
|-----------|-------------|
6062
| `AppShell` | Root wrapper with optional SafeArea |
6163
| `Header` | Scroll-aware header with nav, context, and search rows |
64+
| `HeaderNav` | Container for header navigation links |
65+
| `HeaderNavItem` | Navigation link with dropdown support |
6266
| `Content` | Main content area |
6367
| `Footer` | Tab bar, floating button, or mini bar |
6468
| `FooterItem` | Individual tab inside a tab-bar footer |
69+
| `ScrollNav` | Horizontal scrollable pill navigation |
70+
| `Sidebar` | Animated slide-out menu drawer |
6571
| `SafeArea` | Mobile safe-area inset handler |
6672

6773
## Documentation
6874

69-
Visit the [documentation site](https://appshell.dev) for full API reference, guides, and interactive examples.
75+
Visit the [documentation site](https://fyalavuz.github.io/react-appshell) for full API reference, guides, and interactive examples.
7076

7177
## Examples
7278

73-
See the `apps/examples` directory for 5 fullscreen demos:
79+
Explore 18+ fullscreen demos at [fyalavuz.github.io/react-appshell/examples](https://fyalavuz.github.io/react-appshell/examples):
7480

75-
- **Social App** -- reveal-nav header + auto-hide tab bar
76-
- **E-commerce** -- fixed header + floating cart button
77-
- **Messaging** -- static header + mini input bar
78-
- **Dashboard** -- fixed dark header + static tab bar + mobile menu
79-
- **Music Player** -- reveal-all header + mini now-playing bar
81+
- **Sticky Tabs** -- Header behavior with hitching sub-navigation
82+
- **Combined Reveal** -- All-row header reveal + auto-hide footer
83+
- **Fixed/Static/Reveal** -- Detailed header behavior permutations
84+
- **Sidebar & Desktop Nav** -- Responsive menu patterns
85+
- **Floating & Mini Footers** -- FABs and contextual toolbar patterns
8086

8187
## Contributing
8288

apps/docs/content/docs/components/footer.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ The `Footer` component renders a fixed-position bar at the bottom of the viewpor
2424
| --- | --- | --- | --- |
2525
| `variant` | `FooterVariant` | `"tab-bar"` | Visual variant: `"tab-bar"`, `"floating"`, or `"mini"` |
2626
| `behavior` | `FooterBehavior` | `"static"` | `"static"` (always visible) or `"auto-hide"` (hides on scroll down) |
27+
| `speed` | `"slow" \| "normal" \| "fast"` | `"normal"` | Animation duration for hide/reveal |
2728
| `position` | `FooterPosition` | `"center"` | Alignment for floating variant: `"center"`, `"left"`, or `"right"` |
2829
| `className` | `string` || Additional CSS classes |
2930
| `children` | `ReactNode` || Footer content (FooterItems or custom elements) |

apps/docs/content/docs/components/header.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ The `Header` component renders up to three rows -- navigation, context (title/su
2727
| `title` | `ReactNode` || Primary text in the context row |
2828
| `subtitle` | `ReactNode` || Secondary text below the title |
2929
| `searchContent` | `ReactNode` || Content for the search row (input, filters) |
30-
| `theme` | `HeaderTheme` | `"light"` | Visual theme: `"light"`, `"primary"`, or `"dark"` |
30+
| `theme` | `HeaderTheme` | `"light"` | Visual theme: `"light"`, `"primary"`, `"dark"`, or `"none"` |
3131
| `behavior` | `HeaderBehavior` | `"fixed"` | Scroll behavior (see below) |
32+
| `speed` | `"slow" \| "normal" \| "fast"` | `"normal"` | Animation duration for reveal/hide |
3233
| `mobileMenu` | `ReactNode` || Collapsible menu content for small screens |
3334
| `onVisibilityChange` | `(visible: boolean) => void` || Called when header visibility changes |
3435
| `className` | `string` || Additional CSS classes |

0 commit comments

Comments
 (0)