The News search and filter is used to create a news listing page that allows customers to search and filter the articles displayed.
On this page
- Using a news search and filter
- Adding a news search and filter on a landing page
- See news search and filter on the CMS Components Guide
Using a news search and filter
Do
- Use on landing pages to list large amounts of news articles with the ability to search and filter them.
- Limit other components on your page. The page should mostly be dedicated to the News search and filter component. If you add other elements to the page, such as a summary or call out, position the News search and filter component last on the page.
Don't
- Add more than 1 News search and filter component to your landing page.
Adding a news search and filter on a landing page
To add the News search and filter component to your landing page:
- Create a new full width section and click Add block.
- In the Choose a block screen, search for News Search & Filter and select the component from the search results. The Configure block screen will open and you can adjust the settings.
- Title field: this can be left with the default text or customised. The title will not be visible publicly.
-
General accordion:
- The Filter title will appear at the top of the left side column above any other filter categories that turn on.
- Tick the Show images checkbox to have all of the news articles listed with their accompanying images. You can still choose to show images, even when not all of your news articles have images attached as this component will adapt.
-
Result listings accordion:
- The Results display can be left with the default text of ‘Showing {RANGE} of {TOTAL} results,’ which will display as ‘Showing 1 - 10 of 540 results,’ for example. It will show at the top of the news listings results.
- The No Results Message can be customised or you can leave the default message.
- In Content types tick the checkboxes for all the types of articles that you would like to be captured in your news listing.
- In the Agency field you can either leave this field blank or add an agency to show articles from that agency.
- In the Topic field you can either leave this field blank or add topic to show articles tagged with that topic. If you add both an agency and a topic this will limit the search results to only articles that include both tags – articles with only one of the tags will not be shown.
-
Keyword accordion:
- The Keyword Label can be customised or remain with the default text. It will appear at the top of the left side as a search field for customers to search articles by keyword.
- The Input placeholder is where text can appear within the search bar, for example ‘search for news articles’. It can remain blank.
-
Content type filter accordion:
- By ticking the Show content type filter checkbox, you will enable the filter option of article type. You should tick at least 2 article types in this section and in the above Result listings accordion if you enable this filter option.
-
Tag filters accordion:
- If your news articles have been tagged with additional tags you can add an additional filter option in this section. For example, if your news articles have used the Category tag field, available in the new article template, you can add this as a filter option. In the Vocabulary field you would search for the tag ‘Category.’
- In the Terms field search and select the tags that you added to your news article. For example if you used the ‘Category’ tag field in your news articles and applied the tag ‘Awards and events’ you would add this in the Terms field.
- You can add more tag filters.
-
Date range accordion:
- By ticking the Show date range checkbox a date range selector will automatically populate as a filter option with a To and From fields with a calendar selector option.
- The Node field can be left on the default setting.
- Click the Update button.
See news search and filter live on nsw.gov.au
Visit News search filter to how this works on a live page.
You can also see live examples of how agencies have applied the component.
Need any more help?
If you have any questions, or require assistance with anything mentioned on this article, submit a request via the webform.