Extension NSW Design System Theme


Extension Basics

Title
NSW Design System Theme
Name
ckanext-nswdesignsystem
Type
Public extension
Description
Styling CKAN with NSW Design System
CKAN versions

~2.9, ~2.10, ~2.11

Show details
Download-Url (zip)
Download-Url commit date
2025-10-02
Url to repo
Category
Regional Government Themes


Background Infos

Description (long)
Show details

Collection of tools for styling CKAN using the NSW Design System (Digital NSW). Provides comprehensive macros and components for implementing the NSW government design system in CKAN portals including masthead, header, footer, navigation, forms, cards, filters, accordions, hero banners, dialogs, callouts, progress indicators, and more. Features include component demo page at /nswdesignsystem/components, overridable macros for customization, helper functions for default data (footer links, etc.), and support for both function-style and call-block macro usage. Based on nsw-design-system library v3.20.3 with patches for CKAN-specific features like default-expanded filters.

Version
0.2.16
Version release date
2025-10-02
Contact name
DataShades
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Installation:

1. Install via pip:

pip install ckanext-nswdesignsystem

2. Add ‘nswdesignsystem’ to ckan.plugins in your config file

3. Restart CKAN

#

Usage:

Visit /nswdesignsystem/components to see all implemented components with code examples

#

Component Customization:

- Most components use macros that can be overridden

- Check macro source for customization options

- Some components use helpers like nswdesignsystem_footer_links (should be chained)

- Macros can be used as functions: {{ masthead() }}

- Or with call blocks: {% call masthead() %} content {% endcall %}

#

Available Components:

- Header/Footer/Masthead/Navigation

- Forms (input, select, textarea, checkbox, radio, date picker)

- Cards and Card Grids

- Filters with show-more, immediate submit, cancel URL

- Accordions (single/multi-expand)

- Hero Banners

- Dialogs (modal/dismissible)

- In-Page Alerts

- Callouts, Steps, Progress Indicators

- Tables, Sidebar Navigation

- Popovers, Utility Lists

#

NSW Design System Version:

Current library: nsw-design-system v3.20.3

Update via: npm up nsw-design-system && make vendor

Plugins to configure (ckan.ini)
nswdesignsystem
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions