Kurk žinučių korteles

Kortelės sandara

Kortelės dalys iš viršaus į apačią. Praleisk tai, ko nereikia: kortelė vien su pavadinimu irgi tinka.

#github

Message from GitHub• acme/web

Atidarytas pull request #212

Open

Greitesnė paieška kanalų sąraše

Paieška dabar vyksta po kiekvieno klavišo paspaudimo, su 120 ms debounce.

Autorius

maya

Peržiūrėtojai

dani, sam

10:03

+86-12

1. Antraštė„Message from“ ir pavadinimas: webhook’o pavadinimas arba, atsakant į komandą, tavo bendruomenės pavadinimas. Atsakymas gali pridėti badge, pavyzdžiui, saugyklą.
2. Pavadinimas ir būsenatitle, kuris tampa nuoroda, kai nustatai title_url, su status ženkliuku šalia.
3. PaantraštėAntra paryškinta eilutė, sub_title.
4. AprašymasTurinys, markdown formatu.
5. LaukaiEtiketės ir reikšmės eilutės su kopijavimo mygtuku.
6. PoraštėLaikas, taip pat pridėtos ir pašalintos eilutės, jei jas siunti.

{
  "message_container": {
    "type": "embed_message",
    "badge": "acme/web",
    "color": "purple",
    "title": "Pull request #212 opened",
    "title_url": "https://github.com/acme/web/pull/212",
    "status": { "label": "Open", "color": "green", "icon": "pull_request" },
    "sub_title": "Faster search in the channel list",
    "description": "Search now runs **per keystroke** with a 120 ms debounce.",
    "fields": [
      { "field": "Author", "value": "maya" },
      { "field": "Reviewers", "value": "dani, sam" }
    ],
    "additions": 86,
    "deletions": 12,
    "files_changed": 3
  }
}

Visi laukai

Šie laukai dedami į message_container. Kortelei reikia aprašymo arba loader. Laukai, pažymėti „Atsakymai į komandas“, praleidžiami, kai skelbi per webhook.

Būsena ir diff statistika

Būsenos ženkliukas papasakoja istoriją dar prieš tai, kai kas nors perskaito tekstą. Jis stovi šalia pavadinimo arba, jei pavadinimo nėra, poraštėje; diff statistika rodoma šalia laiko. Abu veikia atsakymuose į komandas, juos naudoja ir įdiegta GitHub integracija. Webhook juos praleidžia.

#github

Message from GitHub• acme/web

Sulietas pull request #212

Merged

11:20

Message from CI• acme/web

Build main šakoje nepavyko

Failing

search.test.js: nepavyko 2 iš 212 testų.

11:24

Message from GitHub• acme/web

maya: push į main

Commit

11:31

+14-3

{
  "message_container": {
    "color": "red",
    "title": "Build failed on main",
    "status": { "label": "Failing", "color": "red" },
    "description": "`search.test.js`: 2 of 212 tests failed."
  }
}

Piktogramos

GitHub tinkantis atitikmenų rinkinys

Įdiegta GitHub integracija naudoja šias reikšmes; nusikopijuok jas savo įrankiams.

Loader ir samprotavimai

Kai kas nors užtrunka, pavyzdžiui, DI atsakymas ar ilga užduotis, pirmiausia paskelbk kortelę su sukučiu, o paskui pakeisk ją rezultatu. Loader veikia ir per webhook’us, ir atsakymuose į komandas. Atsakyme į komandą modelio samprotavimus taip pat gali įdėti į thinking: nariai vietoj teksto sienos matys jungiklį Show thinking.

#assistant

Message from Assistant

Galvoju…Skaitau paskutines 50 žinučių

09:02

Pirmiausia: loader

#assistant

Message from Assistant

maya: kada standup?

Standup 09:30, kanale #daily.

Show thinking

Patikrintos prisegtos žinutės ir pasikartojantis įvykis kanale #daily.

09:02

Paskui: atsakymas, samprotavimai suskleisti

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "loader": true,
    "loader_text": "Thinking…",
    "loader_sub_text": "Reading the last 50 messages"
  }
}

{
  "message_container": {
    "type": "embed_message",
    "color": "blue",
    "sub_title": "maya: when is the standup?",
    "description": "Standup is at **09:30**, in #daily.",
    "thinking": "Checked the pinned messages and the recurring event in #daily…"
  }
}

Norėdamas pakeisti loader atsakymu, atnaujink žinutę nauja kortele be loader. Kaip tai padaryti, rasi puslapyje atnaujinimai realiuoju laiku.

Ilgi aprašymai

Aprašymas gali būti iki 50 000 baitų. Po pirmųjų 1 000 nariai mato pradžią ir mygtuką Show more, kuris įkelia likusią dalį, todėl ilga ataskaita neužtvindo kanalo.

Sisteminės žinutės

Nustatyk "type": "system_message", kai reikia pranešimo, o ne boto įrašo: techninės priežiūros langų, taisyklių pakeitimų, visko, kas kalba pačios bendruomenės vardu. Ji priima tuos pačius laukus ir mygtukus.

{
  "message_container": {
    "type": "system_message",
    "color": "orange",
    "title": "Maintenance tonight",
    "description": "The build servers are down from 22:00 to 23:00."
  }
}

Spalvos

Krašto spalva yra greičiausias kortelės signalas. Tos pačios rūšies naujienoms visada naudok tą pačią spalvą.