Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ Chat: ny small-variant, justert design, forbedret UU #2048

Merged
merged 19 commits into from
Jun 21, 2023
Merged

Conversation

HalvorHaugan
Copy link
Contributor

@HalvorHaugan HalvorHaugan commented Jun 13, 2023

Endringer:

  • Ny small-variant som har mindre font på selve meldingsteksten samt mindre padding i boblene
  • Gjort avatar valgfritt
  • Forbedret UU
    • Gjort om navn+timestamp til <h3> slik at det er enklere å hoppe mellom meldinger
    • Lagt til aria-hidden på avatar for å unngå at eventuelle initialer blir lest opp uten kontekst. (La også merke til at det ble lest opp som ord, og ikke bokstav for bokstav.) Er litt usikker på dette siden name er valgfritt, så må iallfall skrive i dokumentasjonen at man ikke må basere seg på kun avatar (og andre visuelle hint) for å kommunisere avsender. Kunne ev. gjort name obligatorisk, men det er jo breaking change. Et annet alternativ er å bare sette aria-hidden på avatar hvis name er satt.
  • Justert CSS ihht. Figma

Spørsmål/avklaringer:

  • Er det ok å fjerne klassenavn på nesta elementer, eller er det "breaking change"? Burde de legges til i deprecations.ts?
  • Hva synes dere om måten jeg anbefaler hvilke farger man bør bruke? Fant ikke noe måte å gjøre det med TS/jsdoc... Forslag?

TODO:

  • Justere (tekst)størrelsen på avatar for å få plass til tre bokstaver (venter på Linda)
  • Oppdatere dokumentasjonen med anbefalte farger og at avatar har aria-hidden
  • Run yarn changeset for version and changelog generation

@changeset-bot
Copy link

changeset-bot bot commented Jun 13, 2023

🦋 Changeset detected

Latest commit: e00c530

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 7 packages
Name Type
@navikt/ds-css Minor
@navikt/ds-react Minor
@navikt/aksel-stylelint Minor
@navikt/aksel Minor
@navikt/ds-tokens Minor
@navikt/ds-tailwind Minor
@navikt/aksel-icons Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jun 13, 2023

Endringer til review: 8

81b9b3429 | 45 komponenter | 270 stories

@HalvorHaugan HalvorHaugan requested a review from KenAJoh June 13, 2023 12:20
@KenAJoh
Copy link
Collaborator

KenAJoh commented Jun 15, 2023

Tenker måten å oppmuntre til riktig fargebruk funker fint 👌 Kan også legge til flere eksempler i JSdoc, f.eks

/**
 * A component for communicating dialogs between two parties.
 *
 * @see [📝 Documentation](https://aksel.nav.no/komponenter/core/chat)
 * @see 🏷️ {@link ChatProps}
 *
 * @example
 * ```jsx
 * <Chat avatar="A" name="Alice" timestamp="01.01.21 14:00">
 *   <Chat.Bubble>Hello!</Chat.Bubble>
 *   <Chat.Bubble>How can I help you?</Chat.Bubble>
 * </Chat>
 * <Chat avatar="B" name="Bob" timestamp="01.01.21 14:01" position="right">
 *   <Chat.Bubble>Hi there!</Chat.Bubble>
 * </Chat>
 * ```
 * @example
 * ```jsx
 * // With recommended colors
 * <Chat 
 *  avatar="A" 
 *  name="Alice" 
 *  timestamp="01.01.21 14:00" 
 *  backgroundColor="var(--a-surface-info-subtle)" 
 *  avatarBgColor="var(--a-surface-info-subtle)"
 * >
 *   <Chat.Bubble>Hello!</Chat.Bubble>
 *   <Chat.Bubble>How can I help you?</Chat.Bubble>
 * </Chat>
 * <Chat avatar="B" name="Bob" timestamp="01.01.21 14:01" position="right">
 *   <Chat.Bubble>Hi there!</Chat.Bubble>
 * </Chat>
 * ```
 */

@KenAJoh
Copy link
Collaborator

KenAJoh commented Jun 16, 2023

En tanke: Siden vi nå anbefaler 3 spesifikke varianter med subtle, info og default (neutral), bør dette heller være en prop på selve chat-komponenten?

/**
	default "subtle"
*/
variant?: "subtle" | "info" | "neutral"

backgroundColor og avatarBgColors kan fortsette å level/fungere, men tages med @deprecated med jsdoc

@HalvorHaugan
Copy link
Contributor Author

En tanke: Siden vi nå anbefaler 3 spesifikke varianter med subtle, info og default (neutral), bør dette heller være en prop på selve chat-komponenten?

/**
	default "subtle"
*/
variant?: "subtle" | "info" | "neutral"

backgroundColor og avatarBgColors kan fortsette å level/fungere, men tages med @deprecated med jsdoc

Var inne på tanken selv. Er for så vidt enig, men burde kanskje avklares med design?

@HalvorHaugan HalvorHaugan marked this pull request as ready for review June 20, 2023 09:55
@navikt/core/css/chat.css Outdated Show resolved Hide resolved
@navikt/core/css/chat.css Outdated Show resolved Hide resolved
@navikt/core/css/chat.css Outdated Show resolved Hide resolved
KenAJoh
KenAJoh previously approved these changes Jun 20, 2023
Copy link
Collaborator

@KenAJoh KenAJoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@HalvorHaugan HalvorHaugan merged commit b1625ba into main Jun 21, 2023
@HalvorHaugan HalvorHaugan deleted the chat branch June 21, 2023 07:40
@github-actions github-actions bot mentioned this pull request Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants