Skip to main content

📜 Public API

Content Studio follows semantic versioning for its public API: from version 1.0, the names on this page only change in a major release, after a deprecation period with a warning.

The public API consists of:

  • the names below, imported from the module they are listed under;
  • the documented attributes and methods of ModelStudio, InlineModelStudio and ContentStudioSite: the configuration options and the hooks, such as the has_*_permission methods, get_fields, get_readonly_fields, get_prepopulated_fields, get_list_item_display, get_relation_display, get_created_result, get_duplicate_initial, get_tenants, get_thumbnail, get_media_serializer_fields and crop_image;
  • the documented options and methods of blocks: the Meta options of Block, get_context and get_template_name, and the values of a block field (blocks, and each block's id, type, value and render);
  • the render_blocks tag of the content_studio template library;
  • every setting in CONTENT_STUDIO;
  • the system check IDs, but not their messages;
  • content_studio.urls and the content_studio.contrib.password_reset app, as a whole;
  • the content_studio.webhooks app's content_studio_deliver_webhooks command, and the requests its webhooks send: the payload with its version, and the X-Content-Studio-* headers.

Everything else may change in any release, including any name that is not on this page, even when you can import it.

content_studio​

The registration decorator and the package version.

  • VERSION
  • register

content_studio.admin​

Studios, the site and their configuration objects. admin_site is the default site.

  • ContentStudioSite
  • InlineModelStudio
  • ListItemDisplay
  • ModelGroup
  • ModelStudio
  • RelationDisplay
  • admin_site
  • register

content_studio.form​

Edit page layouts, components and table columns. Component is the base type of the built-in components; custom component types are not supported, but Link, ButtonLink and Button are meant to be subclassed.

  • ActivityLog
  • Button
  • ButtonLink
  • ButtonResult
  • Component
  • Field
  • FieldLayout
  • FormSet
  • FormSetGroup
  • Link
  • TableColumn

content_studio.actions​

Custom bulk actions.

  • bulk_action

content_studio.dashboard​

The dashboard and its layout widget. DashboardWidget is the base type of the built-in widgets.

  • Dashboard
  • DashboardWidget
  • SpacingWidget

content_studio.dashboard.*​

The built-in dashboard widgets, each from its own module.

  • content_studio.dashboard.statistic.StatisticWidget
  • content_studio.dashboard.content_list.ContentListWidget
  • content_studio.dashboard.activity_log.ActivityLogWidget
  • content_studio.dashboard.scheduled_tasks.ScheduledTasksWidget

content_studio.extensions​

Menu links, menu buttons and embedded pages.

  • IFramePage
  • MainMenuButton
  • MainMenuLink

content_studio.widgets​

The built-in editing widgets, to use in Field(widget=...) and default_widget_mapping. BaseWidget is their base type; custom widgets are not supported.

  • BaseWidget
  • BlockWidget
  • CheckboxWidget
  • DateTimeWidget
  • DateWidget
  • ForeignKeyWidget
  • InputWidget
  • JSONSchemaWidget
  • JSONWidget
  • ManyMediaWidget
  • ManyToManyWidget
  • MediaWidget
  • MultiSelectWidget
  • RadioButtonWidget
  • RichTextWidget
  • SelectWidget
  • SlugWidget
  • SwitchWidget
  • TagWidget
  • TextAreaWidget
  • TimeWidget
  • ToggleGroupWidget
  • URLPathWidget

content_studio.formats​

The built-in display formats, to use in TableColumn(format=...) and default_format_mapping. BaseFormat is their base type; custom formats are not supported.

  • BaseFormat
  • BlockFormat
  • BooleanFormat
  • DateFormat
  • DateTimeFormat
  • FileSizeFormat
  • ForeignKeyFormat
  • HtmlFormat
  • JSONFormat
  • ManyMediaFormat
  • MediaFormat
  • NumberFormat
  • TagFormat
  • TextFormat
  • TimeFormat

content_studio.fields​

Optional content fields.

  • FlexField
  • HTMLField
  • HashTagField
  • MultipleChoiceField
  • TagField
  • URLPathField

content_studio.blocks​

The block field: an ordered list of content blocks. Block is the base type of the blocks you define.

  • Block
  • BlockField

content_studio.models​

Optional abstract base models.

  • ContentModel
  • EditorModel
  • ManualOrderModel
  • SingletonModel
  • SoftDeletableContentModel
  • SoftDeletableModel
  • TimeStampedModel
  • UUIDModel

content_studio.managers​

Managers of the base models.

  • SingletonManager
  • SoftDeletableManager
  • SoftDeletableQuerySet

content_studio.signals​

The signal sent after changes made in the admin are committed, the changes it carries, and the function that records a change.

  • Change
  • content_changed
  • record_change

content_studio.validators​

Validators used by the content fields, usable on any field.

  • ChoiceOptionsValidator
  • JSONSchemaValidator

content_studio.sanitizers​

The built-in HTML sanitizer, the default HTML_SANITIZER.

  • sanitize_html

content_studio.exceptions​

Raised by registration.

  • AlreadyRegistered
  • NotRegistered

content_studio.media_library.fields​

Media picker fields of the optional media library app.

  • CropField
  • ManyMediaField
  • MediaField

content_studio.media_library.models​

The media library app's concrete models.

  • Folder
  • Media

content_studio.webhooks.models​

The webhooks app's models: the webhooks and their deliveries.

  • Webhook
  • WebhookDelivery

content_studio.webhooks.dashboard​

The webhooks app's dashboard widget.

  • WebhookDeliveriesWidget

content_studio.webhooks.extensions​

The webhooks app's main menu button.

  • DeployButton