CWA Logo
swa
The CWA is in heavy development
The CWA is still in alpha and not ready for production - some code and implementations are likely to change. If you would like to try out the CWA, please enjoy what we have provided and feel free to provide feedback, or get involved on GitHub.
Configuration

Nuxt Config

[object Object]

All CWA configuration lives under the cwa: key in nuxt.config.ts. The module merges your config with its defaults at build time.

Runtime Config

The API URLs are set via Nuxt's runtimeConfig so they can be overridden per-environment using environment variables:

// nuxt.config.ts
export default defineNuxtConfig({
    runtimeConfig: {
        public: {
            cwa: {
                apiUrl: 'http://api-internal',            // server-side (SSR)
                apiUrlBrowser: 'https://api.example.com' // client-side
            }
        }
    }
})

In Docker Compose these typically differ — the server-side URL uses the internal Docker network hostname while the browser URL is the public domain.

Override at deploy time via environment variables:

NUXT_PUBLIC_CWA_API_URL=http://api:8080
NUXT_PUBLIC_CWA_API_URL_BROWSER=https://api.example.com

Full cwa: Reference

export default defineNuxtConfig({
    cwa: {
        // Register your custom components for the admin "Add Component" dialog
        resources: {
            Title: {
                name: 'Title Block',
                description: 'A headline or section title',
                instantAdd: false,      // true = skip config dialog, add immediately
                defaultData: {          // pre-fill fields on creation
                    title: 'New Title'
                },
                classes: [              // CSS class options shown in the admin panel
                    { value: '', label: 'Default' },
                    { value: 'text-center', label: 'Centered' }
                ]
            }
        },

        // Register your layout components for the admin panel
        layouts: {
            Primary: {
                name: 'Primary Layout',
                classes: [
                    { value: 'light', label: 'Light' },
                    { value: 'dark', label: 'Dark' }
                ]
            }
        },

        // Register your page template components
        pages: {
            Primary: {
                name: 'Primary Page',
                classes: []
            },
            BlogDetail: {
                name: 'Blog Article',
                classes: []
            }
        },

        // Register PageData types for the admin data management panel
        pageData: {
            BlogArticleData: {
                name: 'Blog Articles',
                // Human-readable labels for pageDataProperty position pickers.
                // Falls back to auto-split camelCase → Title Case if omitted.
                properties: {
                    htmlContent: 'Article Body',
                    heroImage: 'Hero Image',
                },
                metaFields: [
                    { field: 'headline', type: 'text', label: 'Headline' },
                    { field: 'createdAt', type: 'date', label: 'Created' }
                ]
            }
        },

        // How many levels deep to resolve nested page routes (default: 4)
        pagesDepth: 2,

        // Static defaults for site config — merged with API values, API wins on conflict
        siteConfig: {
            siteName: 'My App',
            canonicalUrl: 'https://www.example.com',
            fallbackTitle: true,
            concatTitle: true,
            indexable: true,
            sitemapEnabled: true
        },

        // Override the Nuxt layout used for CWA content pages (default: 'cwa-root-layout')
        layoutName: 'cwa-root-layout'
    }
})

Config Key Reference

KeyTypeDefaultDescription
resourcesRecord<string, CwaResourceMeta>{}Your CMS component types and their admin metadata
layoutsRecord<string, CwaUiMeta>{}Your layout component types and admin display options
pagesRecord<string, CwaUiMeta>{}Your page template component types
pageDataRecord<string, { name?, properties?, metaFields? }>{}Your PageData resource classes for the admin data panel. properties maps PHP property names to human-readable labels used in position pickers; auto-splits camelCase if omitted.
pagesDepthnumber4Maximum nesting depth for nested page routes
siteConfigPartial<SiteConfigParams>(defaults)Static site config defaults merged with the API
layoutNamestring'cwa-root-layout'Nuxt layout name used on CWA-managed content pages
storeNamestring'cwa'Pinia store name prefix (rarely needs changing)

definePageMeta CWA Options

Pages in your app/pages/ directory can opt in or out of CWA behaviour using definePageMeta:

definePageMeta({
    cwa: {
        // Disable CWA route fetching on this page entirely.
        // The page still mounts but CWA will not fetch a manifest or resolve any resources.
        disabled: true,

        // Use a specific Nuxt layout name for this page, bypassing CWA's layout resolution.
        // Useful when you want a static layout on a hybrid page.
        staticLayout: 'my-static-layout',
    }
})

See Mixing Your Own Pages for the full pattern.

Module Setup

Installing the CWA Nuxt module, configuring peer dependencies, and wiring up the nuxt.config options.

Site Config & SEO

Admin settings panel, siteConfig API, per-page SEO from page data, sitemap, maintenance mode, and robots configuration.