utopia_cms library

Classes

CmsBoolEntry
CmsEntry for handling boolean values
CmsBreakpoints
Single source of truth for utopia_cms responsive breakpoints.
CmsButton
CmsCard
A raised, rounded, hairline-bordered surface - the container the table and other grouped content sit on. Styling comes from CmsThemeData.cardDecoration and cardBorderDecoration, so it stays themable from one place.
CmsChip
A small rounded pill used to display a categorical / tag-like value in a CmsTable cell (e.g. a dropdown value or one element of a to-many relation).
CmsChipList
A wrap of CmsChips with a trailing "+N more" overflow chip.
CmsCountryEntry
CmsEntry for picking countries
CmsCountryField
CmsDateEntry
CmsEntry for handling basic dates
CmsDatePicker
CmsDelegate
  • CmsDelegate is a main interface for handling CmsTable items.
    • CmsDivider
    A hairline divider drawn in the theme's border colour.
    CmsDropdownEntry<T>
    CmsEntry for handling offline items picker
    CmsDropdownField<T>
    CmsEntry<T>
    CmsEntry is an interface of a basic CmsTablePage component.
    CmsEntryModifier
    Modifies the behavior of the CmsEntry
    CmsFieldWrapper
    CmsFilter
    CmsFilterDateEntry
    CmsEntry for handling basic dates
    CmsFilterEntry<T>
    CmsFilterEntry is an interface of a basic CmsTablePage filter component.
    CmsFilterSearchEntry
    CmsFilterEntry for handling basic search
    CmsFunctionsPagingParams
    CmsFunctionsSortingParams
    CmsHeader
    CmsLinkEntry
    CmsEntry that renders a value as a clickable hyperlink.
    CmsLoader
    CmsManagementBaseState
    CmsManagementSectionEntry
    CmsMediaDelegate
    CmsMediaEntry
    CmsEntry for handling images
    CmsMediaField
    CmsMediaFieldAddButton
    CmsMediaFieldImage
    CmsMediaFieldItemWrapper
    CmsMediaFieldState
    CmsMediaFieldUpload
    CmsMediaUploadRes
    CmsMockLoadingBox
    CmsNumEntry
    CmsEntry for handling basic num values
    CmsPageWrapper
    Resolves a CmsPageType from the available width and exposes it to the subtree both through the builder callback and through context.pageType.
    CmsSingleMediaEntry
    Single-file variant of CmsMediaEntry.
    CmsSwitch
    CmsTableAction
  • CmsTableAction appears in the CmsTableItem popUpMenu. Default actions "delete" and "edit" are generated automatically based on CmsTableParams
  • label is displayed after pressing CmsTableActionsButton
  • onPressed is triggered after pressing the item. It provides current item JsonMap value. If shouldUpdateTable is true and result != null, item will be updated in the table.
    • CmsTablePage
  • CmsTablePage by default is able to generate complete flow of data table preview, creation/edition flow.
    • CmsTableParams
    Modifies basic actions' behavior in the CmsTable
    CmsTextEntry
    CmsEntry for handling basic String values
    CmsTextField
    CmsThemeColors
    CmsThemeData
    CmsThemeTextStyles
    CmsToManyDelegate
  • CmsToManyDelegate is an interface for handling toMany relationships.
    • CmsToManyDropdownEntry
    CmsEntry for handling toMany relationships
    CmsVideoPlayer
    CmsVideoPlayerState
    CmsWidget
    CmsWidgetItem
    CmsWidgetMenuParams
    Host-facing menu configuration.
    CountryCode
    Country element. This is the element that contains all the information
    CountryCodePicker
    CountryCodePickerState
    CountryLocalizations
    SelectionBottomSheet
    selection bottom sheet used for selection of the country code
    SelectionDialog
    selection dialog used for selection of the country code

    Enums

    CmsFilterDateEntryMode
    CmsFilterDateEntryUnit
    CmsMediaType
    CmsPageType
    Responsive size class derived from the available width, not the screen size.
    PickerStyle

    Mixins

    ToAlias

    Extensions

    CmsFilterExtensions on CmsFilter
    CmsFilterPatterns on CmsFilter
    Adds pattern-matching-related methods to CmsFilter.
    CmsFunctionsSortingParamsPatterns on CmsFunctionsSortingParams
    Adds pattern-matching-related methods to CmsFunctionsSortingParams.
    CmsMediaTypeListExt on List<CmsMediaType>
    CmsPageTypeContextX on BuildContext
    CmsPageTypeX on CmsPageType
    CmsThemeColorsPatterns on CmsThemeColors
    Adds pattern-matching-related methods to CmsThemeColors.
    CmsThemeDataPatterns on CmsThemeData
    Adds pattern-matching-related methods to CmsThemeData.
    CmsThemeTextStylesPatterns on CmsThemeTextStyles
    Adds pattern-matching-related methods to CmsThemeTextStyles.
    CmsWidgetItemPatterns on CmsWidgetItem
    Adds pattern-matching-related methods to CmsWidgetItem.
    JsonMapExtensions on JsonMap

    Constants

    codes → const List<Map<String, String>>

    Functions

    cmsCardSliver(BuildContext context, {required Widget sliver}) → Widget
    The sliver counterpart of CmsCard: wraps sliver in the card decoration - a filled, rounded, shadowed back layer plus a foreground hairline border.
    cmsFieldDecoration(BuildContext context, {Widget? label, Widget? hint, FloatingLabelBehavior? floatingLabelBehavior}) → InputDecoration
    The shared InputDecoration for every CMS field - the single source of the borderless chrome and the floating-label styling.
    useCmsMediaFieldState({required CmsMediaDelegate delegate, required Iterable? initialValues, required List<CmsMediaType> supportedMedia, required void onChanged(Iterable? values), required String urlBuilder(dynamic object)?, required CmsMediaType mediaTypeBuilder(dynamic object), required NavigatorState navigator, int? maxFiles}) → CmsMediaFieldState
    useCmsVideoPlayerState({required String url}) → CmsVideoPlayerState

    Typedefs

    CmsFileRef = String
    CmsMenuHeaderBuilder = Widget Function(BuildContext context, bool isCollapsed)
    Builds the menu header (logo / branding), pinned above the items.
    JsonMap = Map<String, dynamic>
    OnSavedCallback = Future<void> Function(JsonMap)

    Exceptions / Errors

    CmsDelegateException