Content

Content components are designed to display information about CKAN's core entities in a consistent and structured way. They handle the presentation of complex data structures like packages, organizations, users, and their relationships. These components often work in conjunction with their corresponding wrapper components to provide complete structural and visual representations.

Activity

The activity component displays individual activity stream entries, showing user actions and system events in a structured format. It presents information about what happened, who performed the action, and when it occurred. This component is typically wrapped by the activity_wrapper to provide consistent grouping and styling of multiple activity entries.

Activity components are essential for showing the dynamic nature of a CKAN instance, allowing users to track changes, updates, and interactions with datasets and other content. The component handles various types of activities such as dataset creation, updates, and user interactions.

Usage Example

<!-- Basic activity component -->
{%- call ui.util.call(ui.activity_wrapper) -%}
    {{ ui.activity("User created a new dataset", activity=activity_data) }}
{%- endcall %}

Relationship

The activity component works with activity_wrapper to create organized activity streams. While the activity component handles individual entries, the wrapper provides the container for multiple entries.

The facet component displays individual facet filter options, allowing users to refine search results and browse content by specific criteria. Facets are crucial for data discovery and exploration in CKAN, enabling users to filter datasets by organization, group, license, format, and other attributes.

The facet component typically displays the filter name, available options, and selection status. It works in conjunction with facet_wrapper and facet_section components to create comprehensive filtering interfaces. Facets are particularly important for large data portals where users need to narrow down results efficiently.

Relationship

The facet component is closely related to facet_wrapper and facet_section components. The facet component displays individual filter options, while the wrapper and section components provide the structural container.

Usage Example

<!-- Basic facet component -->
{%- call ui.util.call(ui.facet_wrapper) -%}
    {{ ui.facet("My Organization", key="org", value="my-org", count=15) }}
{%- endcall %}

<!-- Active facet component -->
{%- call ui.util.call(ui.facet_wrapper) -%}
    {{ ui.facet("CSV", key="format", value="csv", count=8, active=true) }}
{%- endcall %}

Parameter	Type	Default	Description
`content`	string	-	The text to display in the facet.
`key`	string	-	The facet key (e.g., "organization", "format").
`value`	string	-	The specific value for this facet option.
`count`	int	-	Number of items matching this facet option.
`active`	bool	-	Whether this facet option is currently active.

Theme-Specific Parameters

Different themes may support additional parameters for styling and behavior:

icon (string): Icon to display with the facet
disabled (bool): Whether the facet is disabled

License

The license component displays license information for datasets and other content. It presents licensing terms in a clear and accessible way, helping users understand the terms under which they can use, share, and modify the data. The component typically shows license name, URL, and description.

License components are important for data governance and compliance, ensuring that users understand the permissions and restrictions associated with datasets. Different themes may present license information differently, but the component interface remains consistent across implementations.

Usage Example

<!-- Basic license component -->
{{ ui.license("Creative Commons Attribution", url="https://creativecommons.org/licenses/by/4.0/") }}

<!-- License without link -->
{{ ui.license("Open Data Commons") }}

Parameter	Type	Default	Description
`content`	string	-	The license name or display text.
`id`	string	-	The license identifier.
`url`	string	-	The URL to the license details.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "full", "abbreviated")
show_icon (bool): Whether to show license icon
inline (bool): Whether to display inline with text
size (string): Size of the license display (e.g., "sm", "lg")
show_url (bool): Whether to show the license URL

Group

The group component displays information about CKAN groups, which are used to organize datasets around specific topics or themes. It presents group metadata including name, description, image, and associated datasets. Groups help users discover related datasets and understand the thematic organization of content.

The group component often includes links to view group details, browse datasets within the group, and access group-specific information. It works with group_wrapper to provide consistent presentation of multiple groups in listings and search results.

Relationship

The group component is typically wrapped by group_wrapper components to provide consistent styling and layout when displaying multiple groups together.

Usage Example

<!-- Basic group component -->
{%- call ui.util.call(ui.group_wrapper) -%}
    {{ ui.group({"name": "test-group", "title": "Test Group", "description": "A test group", "type": "group"}) }}
{%- endcall %}

Parameter	Type	Default	Description
`group`	object	-	The group data object containing group information.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "card", "list")
size (string): Size of the group display (e.g., "sm", "lg")
show_datasets (bool): Whether to show dataset count
show_description (bool): Whether to show group description
show_image (bool): Whether to show group image

Organization

The organization component displays information about CKAN organizations, which represent institutions, departments, or other entities that publish datasets. It presents organizational metadata including name, description, image, and published datasets. Organizations are fundamental to CKAN's data governance model.

The organization component typically includes information about the organization's datasets, members, and administrative structure. It works with organization_wrapper to provide consistent presentation when displaying multiple organizations or organization listings.

Relationship

The organization component is typically wrapped by organization_wrapper components to provide consistent styling and layout when displaying multiple organizations together.

Usage Example

<!-- Basic organization component -->
{%- call ui.util.call(ui.organization_wrapper) -%}
    {{ ui.organization({"name": "test-organization", "title": "Test Organization", "description": "A test organization", "type": "organization"}) }}
{%- endcall %}

Parameter	Type	Default	Description
`organization`	object	-	The organization data object containing organization information.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "card", "list")
size (string): Size of the organization display (e.g., "sm", "lg")
show_datasets (bool): Whether to show dataset count
show_description (bool): Whether to show organization description
show_image (bool): Whether to show organization image

Package

The package component displays information about CKAN packages (datasets), which are the core content items in CKAN. It presents dataset metadata including title, description, resources, tags, and other relevant information. The package component is central to CKAN's data discovery functionality.

The component handles complex dataset information including multiple resources, metadata fields, and relationships with organizations and groups. It works with package_wrapper to provide consistent presentation in search results, listings, and related dataset displays.

Relationship

The package component is typically wrapped by package_wrapper components to provide consistent styling and layout when displaying multiple packages together.

Usage Example

<!-- Basic package component -->
{%- call ui.util.call(ui.package_wrapper) -%}
    {{ ui.package({"name": "test-dataset", "title": "Test Dataset", "description": "A test dataset", "type": "dataset"}) }}
{%- endcall %}

Parameter	Type	Default	Description
`pkg`	object	-	The package/dataset data object containing dataset information.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "card", "list")
size (string): Size of the package display (e.g., "sm", "lg")
show_resources (bool): Whether to show resource count
show_description (bool): Whether to show dataset description
show_badges (bool): Whether to show status badges

Resource

The resource component displays information about individual resources within packages. Resources represent the actual data files or links within a dataset, including file format, size, description, and download links. The component handles various resource types including uploaded files, external links, and API endpoints.

Resource components are crucial for data access, providing users with the means to download, view, or interact with the actual data contained in datasets. The component works with resource_wrapper to provide consistent presentation when displaying multiple resources within a package.

Relationship

The resource component is typically wrapped by resource_wrapper components to provide consistent styling and layout when displaying multiple resources together.

Usage Example

<!-- Basic resource component -->
{%- call ui.util.call(ui.resource_wrapper) -%}
    {{ ui.resource({"name": "test-group", "id": "test-resource", "description": "A test group", "package_id": "test-package"}) }}
{%- endcall %}

Parameter	Type	Default	Description
`resource`	object	-	The resource data object containing resource information.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "card", "list")
size (string): Size of the resource display (e.g., "sm", "lg")
show_download (bool): Whether to show download button
show_format (bool): Whether to show file format
show_size (bool): Whether to show file size

User

The user component displays information about CKAN users, including profile information, activity, and contributions. It presents user metadata such as name, display name, bio, and associated content like created datasets or organizations. The component handles both public profile information and user-specific details when appropriate.

User components are important for community features and understanding content provenance. They work with user_wrapper to provide consistent presentation when displaying multiple users or user listings, such as member lists or contributor information.

Relationship

The user component is typically wrapped by user_wrapper components to provide consistent styling and layout when displaying multiple users together.

Usage Example

<!-- Basic user component -->
{%- call ui.util.call(ui.user_wrapper) -%}
    {{ ui.user({"name": "test-user", "fullname": "Test User", "id": "test-user"}) }}
{%- endcall %}

Parameter	Type	Default	Description
`user`	object	-	The user data object containing user information.

Theme-Specific Parameters

Different themes may support additional parameters for styling and presentation:

variant (string): Style variant (e.g., "card", "inline")
size (string): Size of the user display (e.g., "sm", "lg")
show_avatar (bool): Whether to show user avatar
show_display_name (bool): Whether to show user's display name
show_link (bool): Whether to link to user profile