Real Estate

Import the Real Estate design and it brings blocks and content types of its own, on top of the main Canvas library. Read this page when you are working on a site built from Real Estate and meet a block you cannot find in the main reference.

These items stay registered on every site so that content you have already imported keeps rendering, and they appear in the block inserter only where the design is in use.

Content types this design adds

Properties

canvas_estate_prop

One item is called a Property. You will find them in their own admin menu once the design is installed.

Editor features: comments, editor, excerpt, page-attributes, thumbnail, title
Grouped by: Property Types (canvas_estate_type)
Grouped by: Locations (canvas_estate_area)

Each item carries these extra settings on its edit screen:

Prop Amenities
Prop Area
Prop Area Value
Prop Badge
Prop Badge Class
Prop Baths
Prop Beds
Prop Cleaning
Prop Gallery
Prop Host
Prop Host Image
Prop Host Role
Prop Internet
Prop Listing Type
Prop Location
Prop Map
Prop Period
Prop Pool
Prop Price
Prop Price Value
Prop Specs
Prop Strip
Prop Video

Blocks this design adds

Estate Properties

canvas-core/estate-properties

Property cards with badge, price, gallery strip and feature grid, as a grid, carousel or similar-properties row, plus the property single layouts. In the block inserter it is named Estate Properties.

Select the block on a page and its own settings open in the sidebar, in the panels below:

Layout

LayoutDefaultListing Grid

Which part of the design this block draws. The first three belong on a listing page; every choice beginning with Single draws one piece of a single property page and renders nothing anywhere else.

ChoicesListing GridCard CarouselSimilar Properties RowSingle - Hero BannerSingle - Stat StripSingle - SpecificationSingle - AmenitiesSingle - Map EmbedSingle - Video EmbedSearch Result Summary

Query

Property Type SlugDefaultEmpty

Show only one property type. Leave empty for every property.
Curated PropertiesDefaultEmpty

Comma-separated property ids shown in this order. Leave empty to query.
PropertiesDefault0

0 shows every property.
Order ByDefaultMenu Order

What decides the sequence properties appear in: the order you arranged them in, when each was published, or the property name.

ChoicesMenu OrderDateTitle
OrderDefaultAscending

Whether that sequence runs forwards or backwards. With Order By set to Date, Descending puts the newest listing first.

ChoicesAscendingDescending
Listing Page SlugDefaultlisting

The listing page the property-type eyebrow links back to.

Display

Grid Wrapper ClassesDefaultreal-estate mt-5 row portfolio gutter-20 col-mb-50

Classes on the listing-grid wrapper row.
Carousel Wrapper ClassesDefaultreal-estate owl-carousel image-carousel carousel-widget mb-6

Classes on the card-carousel wrapper.
Card Column ClassesDefaultEmpty

Grid column classes on each card. Empty uses the layout default (listing: col-12 col-md-6 col-lg-4; similar row: col-md-6 col-xl-4).
Feature Cell ClassesDefaultcol-lg-4 col-6 p-0

Column classes on each Beds/Baths/Area cell.
Feature Grid ClassesDefaultfw-medium

Style classes on the row of beds, baths and floor area on a card.
Primary Font on First Card FeaturesDefaultOn

The design sets the primary font on the first card's feature grid only.
Gallery LightboxDefaultOn

Open the property photos in a lightbox from the card's image strip.
Similar Properties HeadingDefaultSimilar Properties

Heading above the row of comparable properties at the foot of a property page.

Shown when Layout is "Similar Properties Row"
Hero HeightDefault550px

How tall the opening banner of a property page is. Give it a length, such as 550px, or a share of the screen, such as 70vh.

Shown when Layout is "Single - Hero Banner"
Gallery Button TextDefaultView Gallery

Wording on the banner button that opens the property photos.

Shown when Layout is "Single - Hero Banner"
Video Button TextDefaultPlay Video

Wording on the banner button that plays the property video.

Shown when Layout is "Single - Hero Banner"
Specification HeadingDefaultSpecification

Heading above the table of property details.

Shown when Layout is "Single - Specification"
Amenities HeadingDefaultAmenities

Heading above the list of what the property offers.

Shown when Layout is "Single - Amenities"

Search

Filter From SearchDefaultOff

Narrow the properties to the criteria in the page address, as submitted by a property search form. No criteria shows everything.
Property Type ArgumentDefaultproperty-type

The search form field name carrying the property type. Its values are property-type term slugs.

Shown when Filter From Search is on
Location ArgumentDefaultlocations

The search form field name carrying the locations. Its values are location term slugs; several may be chosen.

Shown when Filter From Search is on
Buy / Rent ArgumentDefaultlisting-type

The search form field name carrying the Buy/Rent switch. Its values are "buy" and "rent".

Shown when Filter From Search is on
Bedrooms ArgumentDefaultbeds

The search form field name carrying the bedroom counts. A value of "4" means exactly four; "5+" means five or more; several may be chosen.

Shown when Filter From Search is on
Bathrooms ArgumentDefaultbaths

The search form field name carrying the bathroom counts, on the same "4" / "5+" contract as the bedrooms.

Shown when Filter From Search is on
Price Range ArgumentDefaultprice-range

The search form field name carrying the price range slider. A handle left at its end of the track applies no limit on that side.

Shown when Filter From Search is on
Area Range ArgumentDefaultarea-range

The search form field name carrying the floor-area range slider, on the same contract as the price range.

Shown when Filter From Search is on
Price PrefixDefault$

Written before a price where the search summary lists the active price range.

Shown when Filter From Search is on
Area SuffixDefaultsqm

Written after a floor area, one space clear of the number, where the search summary lists the active area range.

Shown when Filter From Search is on
Truncated Results TextDefaultShowing the first %1$d of %2$d matches.

Shown under the cards when a search matches more properties than this grid displays. Use %1$d for the number shown and %2$d for the number matched. Empty says nothing.

Shown when Filter From Search is on
Truncated Results ClassesDefaultcol-12 mt-3 text-center real-estate-search-more

Style classes on that line, which is what gives it the full width of the row and centres it under the cards.

Shown when Filter From Search is on
No Results MessageDefaultNo properties match your search.

Shown in place of the cards when a search matches nothing, so a filtered page never looks broken.

Shown when Filter From Search is on
No Results ClassesDefaultcol-12 text-center real-estate-search-empty

Style classes on that message, which is what gives it the full width of the row and centres it.

Shown when Filter From Search is on
Result Count TextDefault%d properties match your search

Use %d where the number of matches belongs.

Shown when Layout is "Search Result Summary"
Result Count Text (one match)Default1 property matches your search

Used in place of the line above when exactly one property matches, so the sentence reads correctly in the singular.

Shown when Layout is "Search Result Summary"
Criteria PrefixDefaultFiltered by

Introduces the list of active criteria. Empty lists the count alone.

Shown when Layout is "Search Result Summary"
Clear Link TextDefaultClear

Links back to the unfiltered listing. Empty omits the link.

Shown when Layout is "Search Result Summary"
Summary ClassesDefaultcol-12 mt-3 real-estate-search-summary

Style classes on the search summary line, which is what gives it the full width of the row and the gap above it.

Shown when Layout is "Search Result Summary"

Was this page helpful?