Component

Chat entry

Entry point for GOV.UK Chat

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

How to call this component

<%= render "govuk_publishing_components/components/chat_entry", {
} %>

Accessibility acceptance criteria

The heading must:

  • be part of a correct heading structure for a page
  • be semantically represented as a heading
  • convey the heading level

Links in the component must:

  • accept focus
  • be focusable with a keyboard
  • be usable with a keyboard
  • indicate when they have focus
  • change in appearance when touched (in the touch-down state)
  • change in appearance when hovered
  • be usable with touch
  • be usable with voice commands
  • have visible text
  • have meaningful text

Other examples

Standard options

This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the component wrapper helper documentation for more detail.

  • id - accepts a string for the element ID attribute
  • data_attributes - accepts a hash of data attributes
  • aria - accepts a hash of aria attributes
  • classes - accepts a space separated string of classes, these should not be used for styling and must be prefixed with js-
  • margin_bottom - accepts a number from 0 to 9 (0px to 60px) using the GOV.UK Frontend spacing scale (defaults to no margin)
  • role - accepts a space separated string of roles
  • lang - accepts a language attribute value
  • open - accepts an open attribute value (true or false)
  • hidden - accepts an empty string, ‘hidden’, or ‘until-found’
  • tabindex - accepts an integer. The integer can also be passed as a string.
  • dir - accepts ‘rtl’, ‘ltr’, or ‘auto’.

With custom href, heading and or description (preview)

Go to GOV.UK Chat

Get answers to your business questions

<%= render "govuk_publishing_components/components/chat_entry", {
  href: "/chat",
  heading_text: "Go to GOV.UK Chat",
  description_text: "Get answers to your business questions"
} %>

With a different heading level (preview)

Chat entry has a h2 by default, but this can be changed. The heading level does not change any styling.

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  heading_level: 3
} %>

With a border top (preview)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  border_top: true
} %>

With a border bottom (preview)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  border_bottom: true
} %>

With a border top and a border bottom (preview)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  border_top: true,
  border_bottom: true
} %>

With margin bottom (preview)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  margin_bottom: 3
} %>

With margin top until tablet (preview)

Adds a .gem-c-chat-entry--margin-top-until-tablet class that applies margin-top:35px on smaller screen sizes (i.e. tablets and below)

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  margin_top_until_tablet: true
} %>

Without ga4 tracking (preview)

Disables GA4 tracking on the component. Tracking is enabled by default. This adds a data module and data-attributes with JSON data. See the ga4-link-tracker documentation for more information.

Ask GOV.UK Chat

Get quick, tailored answers to your business questions with GOV.UK’s new AI tool

<%= render "govuk_publishing_components/components/chat_entry", {
  disable_ga4: true
} %>