Return to Components

1. Circulars

1.1 What are Circulars?

Cirulars are the key component for a CirularList. This component defines the object that will be rendered inside a CircularList. There are 2 sections to Circulars and different fields will be required depending on the purpose of the Ciruclar you want to create.

Circular List Example

1.2 How to create a Ciruclar

1.2.1 The general details for a Circular

Circulars Example 1

Field	Description	Required?
Title	The header label for the Circular	Yes
Name	The name of the Circular to help search for the component in Strapi	Yes
CircularId	The unique identifier for the Circular (auto-generated from Name)	Yes
Description	The description of the Circular this will appear on the item	Yes
Tags	Attach a tag to the object to help filter	No
Type	This defines the type of file that will be uploaded or if the item is a blog	Yes
Document	This is where you upload the document if you are uploading a file. If you are creating a blog then this will be the image for the item	Yes
FilterKey	This is the filter key that must match the filter key of the CircularList	Yes
Category	Attach a category to the object to help filter	Yes

1.2.2 Creating a Circular for a blog

Below the above section you will see space for text, images and videos. These fields define what is rendered by a the blog objects. Click here to see how to create a blog.

Field	Description
text (1-5)	These are text areas in markdown
image (1-5)	These are uploads for images
video (1-2)	These are for entering video codes
video type (1-2)	These are for selecting the video type (Youtube or Wistia)

1.3 How can this component be developed further?

1.3.1 More file types supported

Currently there are gaps in the file types supported. A major one is .xlsx files