ui

Ready-made Jetpack Compose screens, and the design system that themes them.

Every screen is self-contained: give it an identifier and a callback, and it fetches, paginates and renders on its own. It never navigates — it reports what the user did through a sealed event type and leaves the destination to you.

CgsTheme(colorScheme = cgsColorScheme(isSystemInDarkTheme())) {
    PublicationScreen(publicationId = id) { event ->
        when (event) {
            is PublicationEvent.ClickOnIssue -> navigateToReader(event.issue, event.page)
            is PublicationEvent.ClickOnArticle -> navigateToArticles(event.articles, event.index)
            is PublicationEvent.ClickOnSeeAllArticles -> navigateToArticleList(id)
            is PublicationEvent.ClickOnSeeAllArchives -> navigateToArchives(event.publication.id)
        }
    }
}


PublicationScreen	A publication: its latest issue, its articles, a preview of its archives.
ArticleListScreen	Every article of a publication, paginated.
ArchivesScreen	Every archived issue of a publication, year by year.
LibraryScreen	The issues downloaded on this device.
CorporateMediaScreen	A corporate media's documents.
VideoMediaScreen	Videos across a set of publications.

Theming

Wrap anything from this module in CgsTheme. Out of the box it uses the SDK's own palette; two levels of customisation are available above that:

Your brand color — cgsColorScheme(darkTheme, brand, accent) derives a complete, contrast-checked scheme from two colors.
Token by token — lightColorScheme and darkColorScheme take a replacement for any group of the palette.

Screens that accept a colors parameter can also be re-coloured one at a time, without touching the theme.

Packages

co.cafeyn.cgs.api.components

androidJvm

Individual pieces — an article card, a document row, a video grid — for building a screen the SDK does not already provide. Unlike the screens, these are stateless: you pass the data in and handle the clicks yourself.

co.cafeyn.cgs.api.components.colors

androidJvm

The color sets each component accepts. Every one comes with a …Default object that reads the current CgsTheme — start there and override only what you need.

co.cafeyn.cgs.api.components.state

androidJvm

What the stateless components render. Map your own data into these before handing it over.

co.cafeyn.cgs.api.features.library

androidJvm

The library screen: every issue the download manager holds for the current profile, and the selection mode that deletes them.

co.cafeyn.cgs.api.features.media.corporate

androidJvm

The corporate media screen, listing a media's documents.

co.cafeyn.cgs.api.features.media.video

androidJvm

The video screen, listing videos across a set of publications.

co.cafeyn.cgs.api.features.publication

androidJvm

The three publication screens — the publication itself, its full article list, and its archives — with the events they emit and the colors they accept.

co.cafeyn.cgs.api.foundation.design

androidJvm

The design system: CgsTheme, the color palette, and the type scale. This is what you touch to make the SDK's screens look like your app.

co.cafeyn.cgs.api.testing

androidJvm

Stable test tags on the SDK's own composables, so your UI tests can address them without depending on text that translates or layout that moves.