@gravitee/graphene-core 2.52.0-feat-layout-content-width-tiers.41415b9 → 2.52.0-graphene-142-code-editor.aaa181c

package/USAGE_GUIDE.md

@@ -141,47 +141,9 @@ Scale: `0`, `0.5`, `1`, `1.5`, `2`, `2.5`, `3`, `3.5`, `4`, `5`, `6`, `7`, `8`,
 
 `rounded-sm`, `rounded-md`, `rounded-lg`, `rounded-xl` (mapped to semantic `--radius`).
 
-### Layout — content width system
+### Layout
 
-All pages share a single uniform container (100rem / 1600px, centered). No per-page width decisions needed — the container never changes between sibling pages, eliminating layout shifts during navigation.
-
-| Layer | Token | Rem | When to use |
-|-------|-------|-----|-------------|
-| Container (default) | `--content-max-width` | `100rem` | Everything. Applied automatically by `AppLayout`. |
-| Full-bleed | N/A | none | Tool layouts (Policy Studio, LLM Studio). Set via `useLayoutConfig({ contentVariant: 'full-bleed' })`. |
-| `<PageFocused>` | `--content-focused-width` | `56rem` | Optional. Creation wizards, steppers, onboarding flows. |
-
-**Decision rule:**
-
-1. Is this a tool/workspace layout? → `useLayoutConfig({ contentVariant: 'full-bleed' })`
-2. Is this a single-column creation wizard or stepper? → Wrap content in `<PageFocused>`
-3. Everything else → Do nothing. The 100rem centered container handles tables, forms, dashboards, and settings equally.
-
-```tsx
-import { PageFocused } from '@gravitee/graphene-core';
-
-// Wizard/creation page — focused and centered
-function CreateApiPage() {
-  return (
-    <PageFocused>
-      <StepProgress steps={steps} activeStep={step} />
-      <StepContent />
-    </PageFocused>
-  );
-}
-
-// Everything else — just render content directly
-function ApisPage() {
-  return (
-    <div className="space-y-4">
-      <h2>APIs</h2>
-      <DataTable ... />
-    </div>
-  );
-}
-```
-
-All width values are in `rem` so they scale with user font-size preferences and browser zoom. Do NOT set `max-w-*` classes on page wrappers — the design system handles it via `AppLayout`.
+- Content max width is defined on the theme token `--container-content` (maps to `--content-max-width`). Use the max-width utility Tailwind emits for that token in your setup.
 
 ## Styling
 
@@ -331,108 +293,27 @@ If you have not migrated to `AppContextBar` yet, keeping the app name as the fir
 
 **Linear breadcrumbs:** When each step maps to a **path string** and React Router’s `navigate`, use **`buildLinearBreadcrumbs(navigate, segments)`** so `ContentHeader` / `useLayoutConfig` get consistent `BreadcrumbEntry[]` without copying the same `onClick` wiring. If the first crumb is a **custom action** (e.g. “back” that is not `navigate('/path')`), build that entry by hand or mix with `buildLinearBreadcrumbs`—see Storybook **Composed/ContentHeader → Linear breadcrumbs from builder** for the canonical route-based pattern. API edge cases are covered in `packages/core/src/lib/breadcrumbs/buildLinearBreadcrumbs.test.ts`.
 
-### `contentVariant` — content width tiers
-
-`AppLayout` accepts `contentVariant` to control content area width and padding:
+### `contentVariant` — full-bleed content
 
-- `"default"` (default) — `max-w-content` (80rem) with standard padding. Most pages.
-- `"wide"` — `max-w-wide` (100rem) with standard padding. DataTable list pages.
-- `"full-bleed"` — no max-width, no padding; content spans edge-to-edge. Tool layouts and observability pages.
+`AppLayout` accepts `contentVariant` to control content area padding:
 
-```tsx
-// Default (80rem) — no change needed, AppLayout applies it automatically
-<AppLayout>
-  <DetailPage />
-</AppLayout>
-
-// Wide (100rem) — for DataTable list pages, add one line
-useLayoutConfig({ contentVariant: 'wide' }, []);
-
-// Full-bleed — for tool layouts and observability pages
-useLayoutConfig({ contentVariant: 'full-bleed' }, []);
-```
+- `"default"` (default) — standard padding on all sides.
+- `"full-bleed"` — no padding; content spans edge-to-edge.
 
-With `useLayoutConfig` (module federation), a nested page can set `contentVariant` without affecting other layout slots owned by parent components. Each hook only resets the keys it owns on unmount.
-
-#### Artifact-free page transitions
-
-When navigating between pages with different `contentVariant` values, wrap the navigation action in `startLayoutTransition` to eliminate visual overlap artifacts during DOM reconciliation:
+Use `full-bleed` for embedded components that manage their own layout grid (Policy Studio, dashboards, full-screen editors):
 
 ```tsx
-import { startLayoutTransition } from '@gravitee/graphene-core';
-
-// In your router or navigation handler (called once, not per-page):
-function useAppNavigate() {
-  const navigate = useNavigate();
-  return useCallback((to: string) => {
-    startLayoutTransition(() => navigate(to));
-  }, [navigate]);
-}
-```
-
-This uses the View Transitions API to capture the old visual state before applying DOM changes, preventing any intermediate "two pages visible" flash. No visible animation is produced; the swap is perceptually instant. Falls back to direct execution in browsers without View Transitions API support.
-
-When the user has **Reduce motion** enabled at the OS level (`prefers-reduced-motion: reduce`), view-transition animation duration is `0ms` and navigation is fully instant.
-
-### `banner` — full-width status slot
-
-`AppLayout` accepts a `banner` prop that renders a full-width region above the padded content wrapper but inside the scroll container. Use it for persistent status indicators with an action (deploy status, environment warnings).
-
-```tsx
-// Direct prop usage
-<AppLayout banner={<DeployStrip />} bannerSticky>
-  <PageContent />
+<AppLayout contentVariant="full-bleed">
+  <PolicyStudio {...props} />
 </AppLayout>
-
-// Module federation via useLayoutConfig
-useLayoutConfig({
-  banner: deployState === 'NEED_REDEPLOY' ? (
-    <DeployStrip onDeploy={handleDeploy} isPending={isPending} />
-  ) : null,
-  bannerSticky: true,
-}, [deployState, handleDeploy, isPending]);
 ```
 
-The banner spans full width regardless of `contentVariant`. When `bannerSticky` is true, it sticks to the top of the scroll area so the action remains reachable while scrolling.
-
-**Button hierarchy:** When a banner contains an action button alongside page content that has its own primary buttons, use an outline treatment on the banner button to avoid competing with the page's primary CTA:
+With `useLayoutConfig` (module federation), a nested page can set `contentVariant` without affecting other layout slots owned by parent components:
 
 ```tsx
-function DeployStrip({ onDeploy, isPending }) {
-  return (
-    <div className="flex items-center gap-2 border-b border-border px-5 py-1.5">
-      <span className="size-1.5 shrink-0 rounded-full bg-warning" />
-      <span className="text-sm text-muted-foreground">Undeployed changes</span>
-      <div className="flex-1" />
-      <button
-        type="button"
-        className="rounded-md border border-warning/25 bg-warning/5 px-2.5 py-0.5 text-sm font-semibold text-warning-foreground transition-colors hover:bg-warning/10 disabled:opacity-50"
-        onClick={onDeploy}
-        disabled={isPending}
-      >
-        {isPending ? 'Deploying…' : 'Deploy API'}
-      </button>
-    </div>
-  );
-}
+useLayoutConfig({ contentVariant: 'full-bleed' }, []);
 ```
 
-See Storybook **Composed/AppLayout → BannerSlot** for the full interactive example.
-
-### Adopting content width tiers in consumer modules
-
-Follow these steps to apply the layout tier system to an existing consumer module:
-
-1. **Identify all pages** in your module that render inside `AppLayout`.
-2. **Categorize each page:**
-   - **Default** — detail views, edit forms, overviews, settings, creation wizards. No change needed; `AppLayout` applies `max-w-content` (80rem) automatically.
-   - **Wide** — any page whose primary content is a `DataTable`. Add `useLayoutConfig({ contentVariant: 'wide' }, [])` at the top of the component.
-   - **Full-bleed** — tool layouts (Policy Studio) or observability pages (dashboards, explorers). Add `useLayoutConfig({ contentVariant: 'full-bleed' }, [])` if not already set.
-3. **Remove ad-hoc width constraints** — delete any `max-w-*` classes on page-level wrapper divs. The design system owns content width.
-4. **Verify** — resize the browser to confirm content centers correctly on wide viewports and doesn't clip on narrow ones.
-
-See `packages/core/snippets/data-table-list-page.tsx` for a complete list-page example with `useLayoutConfig`.
-
 ### Data table (entity list pages)
 
 Use `DataTable` for any entity list — whether the data is fetched page-by-page from an API or loaded in full on the client. The component provides sorting, filtering, pagination, column visibility, row selection, and bulk actions through a composable slot API.