Community project. This is not an official government website.

Run by volunteers. Lampung Design System is built by an open source community. No government agency runs or endorses it.

Official services use go.id. Government websites in Indonesia end in .go.id. Never enter your national ID number on a site you are unsure of.

Hints

Hints

A short tip that teaches a shortcut or a gesture, shown on the first few visits only and gone for good once closed. It gets quieter with use: by the time people know the trick, the hint has retired itself.

Usage

Use it when

  • A gesture or shortcut that is not visible: swipe a row, press / to search, long press for more.
  • A feature that people miss in testing, where a one-line tip is enough.

Use something else when

  • A guided tour pointing at parts of the screen: use Coachmark.
  • Something wrong or important now: use Alert.
  • Explaining a term next to a label: use Tooltip. Use an info tip.
  • A message after an action: use Toast.
  • Help that should always be there: use Prose.

Where it goes. Directly above or beside what it teaches: over the list that can be swiped, next to the search field with a shortcut. One hint per screen at most. Wrap it in a .collapse so closing it closes its space.

Examples

Teach a gestureShown on the first three visits to this page. Close it and it is gone for good; Show again resets it (from a help menu in a real product).
Swipe a row left to pin, archive or delete it.
Lab report feedbackTwo comments on section 3
Seminar room changedNow in building C, room 204
<div class="collapse"><div>
  <div class="hint" data-lds-hint="swipe-rows" data-max="3" role="note">
    <span class="ic" aria-hidden="true">touch_app</span>
    <span><b>Swipe a row left</b> to pin, archive or delete it.</span>
    <button class="hint__close" data-lds-hint-close aria-label="Hide this hint"><span class="ic ic--sm" aria-hidden="true">close</span></button>
  </div>
</div></div>
<!-- Help menu: import { resetHints } from 'lampung-design-system/js'; resetHints(); -->
Teach a shortcutA keyboard shortcut next to the search it opens, for the first five visits.
Press / to search your courses from anywhere.
<div class="docs-col" style="max-width: 420px;">
  <div class="collapse"><div><div class="hint" data-lds-hint="docs-slash-search" data-max="5" role="note"><span class="ic" aria-hidden="true">search</span><span>Press <span class="kbd">/</span> to search your courses from anywhere.</span><button class="hint__close" data-lds-hint-close aria-label="Hide this hint"><span class="ic ic--sm" aria-hidden="true">close</span></button></div></div></div>
  <div class="control search"><span class="ic" aria-hidden="true">search</span><input aria-label="Search courses" placeholder="Search courses"></div>
  <button class="btn btn--plain btn--sm" style="align-self: flex-start; margin-left: -10px;" onclick="import('../../js/lds.js').then((m) => { m.resetHints(['docs-slash-search']); const box = this.closest('.docs-col'); const h = box.querySelector('.hint'); h.hidden = false; box.querySelector('.collapse').classList.remove('is-closed'); });"><span class="ic" aria-hidden="true">refresh</span>Show the hint again</button>
</div>

Anatomy

PartWhat it is
.hintRequired. data-lds-hint="<key>", data-max="3", role="note". Accent tint, icon, one sentence with the key words in bold.
.hint__closeRequired. data-lds-hint-close, aria-label="Hide this hint". Retires the hint at once.
.collapseRecommended wrapper: closing collapses the space instead of making the page jump.

States

StateHow
shownVisits counted so far are below data-max; the count goes up by one per page load (data-seen).
retiredAfter data-max visits, or as soon as it is closed: hidden, and the .collapse around it closes.
resetresetHints([keys]) clears the counts, so the hint shows again on the next load.

Motion and microinteractions

  • The hint itself does not animate in: it is part of the page when the page appears.
  • Closing collapses the wrapping .collapse: rows to 0fr on --spring-smooth (560 ms) while it fades over --d-standard, so the content below glides up.
  • Reduced motion: the close takes 120 ms.

Accessibility

  • role="note": read in place, not announced as an alert.
  • The close button has an aria-label. After closing, move focus to what the hint was about if focus was on the close button.
  • Say the gesture and its keyboard or button equivalent when there is one.

Do and don't

Do

  • Give each hint a stable key and a small data-max (3 to 5).
  • Let people bring hints back from a help menu with resetHints().
  • Keep it to one sentence with the action in bold.

Don't

  • Show more than one hint on a screen.
  • Use a hint for errors or announcements.
  • Hide the only way to an action behind a hint.

Behavior and code

Plain HTML. [data-lds-hint] on init() counts the visit in localStorage (lds-hint:<key>) and hides the hint once the count reaches data-max; [data-lds-hint-close] retires it at once and closes its .collapse. resetHints(keys?) clears all or the named counts. If storage is blocked the hint always shows.