Digital pattern library

Search results

The search results pattern is used to present a list of links typically from a search service. Different types of results may require different content to be featured, so this pattern has a number of options to provide for this.

Rules for search results

Options available


Simple result

The simplest implementation must include a heading for each result that links to the corresponding resource. This could be a web page, file or URL.

Example
  1. This is the heading of the web page

  2. This is the name of a document

Code

  1. This is the heading of the web page

  2. This is the name of a document


Standard result

The standard implementation may include an optional path to the result, an optional short descriptive summary and also a heading label for secondary information.

Example
  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.

Code

  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.


Additional result metadata

Results can also include metadata to provide quick key information about a resource. These consist of a series of type and value pairs, with icons representing the type of metadata. Metadata may either span the width of the result listing or be displayed as an inline list.

Example
  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

    File location
    This is a full width metadata field that can be used for prominent or longer values
    Published date
    18 July 2019
    Document type
    Guidance
    Scope (applies to)
    All staff
  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.

    Published date
    21 April 2019
    Document type
    Guidance
    Scope (applies to)
    All staff
    Location
    London, UK
Code

  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

    File location
    This is a full width metadata field that can be used for prominent or longer values
    Published date
    18 July 2019
    Document type
    Guidance
    Scope (applies to)
    All staff
  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.

    Published date
    21 April 2019
    Document type
    Guidance
    Scope (applies to)
    All staff
    Location
    London, UK

Image within result

It may also be beneficial to include a thumbnail image to give additional context to a search result.

Example
  1. Heading for the results group

  2. This is a headline of a news article

    https://www.st-andrews.ac.uk/path/to/page/
    Alt text for image

    This is the maximum number of characters that can be used in a search result summary giving a clear indication of what the result is and supporting the heading.

    Published date
    18 July 2019
  3. This is a headline of a news article

    https://www.st-andrews.ac.uk/path/to/page/
    Alt text for image

    This is the maximum number of characters that can be used in a search result summary giving a clear indication of what the result is and supporting the heading.

    Published date
    18 July 2019
Code

  1. Heading for the results group

  2. This is a headline of a news article

    https://www.st-andrews.ac.uk/path/to/page/
    Alt text for image

    This is the maximum number of characters that can be used in a search result summary giving a clear indication of what the result is and supporting the heading.

    Published date
    18 July 2019
  3. This is a headline of a news article

    https://www.st-andrews.ac.uk/path/to/page/
    Alt text for image

    This is the maximum number of characters that can be used in a search result summary giving a clear indication of what the result is and supporting the heading.

    Published date
    18 July 2019