@hanzo/ui

บล็อก

เนื้อหาเป็นข้อมูล หน้าคือรายการของบล็อก แต่ละอันบอกชนิด ชนิดเลือกตัวเรนเดอร์ และตัวเรนเดอร์อ่านที่เหลือ

import { Content, type Block } from '@hanzo/ui/blocks'

<Content blocks={page} />

บล็อกคือข้อมูล blockType เลือกตัวเรนเดอร์ และฟิลด์อื่นเป็นอินพุตของตัวเรนเดอร์นั้น ดังนั้นหน้าเขียนใน CMS ได้ เช็คอินเข้าที่เก็บได้ หรือให้เซิร์ฟเวอร์ผลิตได้ และมีชนิดไม่ว่าทางใด ทุกฟิลด์ specifiers เป็นถุงของคำใบ้การจัดวางคั่นด้วยช่องว่างที่ตัวเรนเดอร์อ่าน มันเป็นสตริงไม่ใช่ยูเนียน ดังนั้นไซต์เพิ่มคำใบ้ด้วยการพิมพ์ และคำใบ้ที่ไม่รู้จักถูกเพิกเฉย ไม่ใช่ทำให้บิลด์พัง

หน้าหนึ่ง

import { Content, type Block } from '@hanzo/ui/blocks'

const page: Block[] = [
  {
    blockType: 'enh-heading',
    preheading: { text: 'Blocks' },
    heading: { text: 'Content as data', level: 2 },
    byline: { text: 'A page is a list of blocks; the type picks the renderer.' },
  },
  { blockType: 'space', sizes: 4 },
  {
    blockType: 'bullet-cards',
    grid: { at: { xs: { columns: 1, gap: 2 }, md: { columns: 3, gap: 3 } } },
    cards: [{ text: 'Typed either way' }, { text: 'Authored anywhere' }, { text: 'Rendered once' }],
  },
  { blockType: 'space', sizes: 4 },
  {
    blockType: 'cta',
    elements: [
      { title: 'Read the docs', href: '/docs' },
      { title: 'Source', href: 'https://github.com/hanzoai/ui', variant: 'outline' },
    ],
  },
]

<Content blocks={page} />

Blocks

Content as data

A page is a list of blocks; the type picks the renderer.

Typed either way

Authored anywhere

Rendered once

คำศัพท์

ชนิดสิ่งที่วาด
headingหัวเรื่องพร้อมบรรทัดรองที่เลือกได้ level 0 สำหรับย่อหน้า และ 1 ถึง 6 สำหรับแท็ก
enh-headingส่วนที่ถูกตั้งชื่อ หัวนำด้านบน หัวเรื่อง บรรทัดรองด้านล่าง แต่ละส่วนมีระดับและมาร์จินของตัวเอง
imageภาพจาก ImageDef — src, alt, dim — พร้อมการจัดแนวและคำใบ้โทรศัพท์ใน specifiers
videoVideoDef แหล่ง โปสเตอร์ ขนาดต่อขั้น
spaceที่ว่างแนวตั้งในหน่วยระยะ ต่อขั้น หรือตัวเลขเดียวสำหรับทั้งหมด
ctaแถวของลิงก์และปุ่ม fill, left, right และคำใบ้โทรศัพท์
cardแผงมีชื่อพร้อมสื่อ เนื้อหา และคำเรียกให้ทำ
bullet-cardsกริดของการ์ดบรรทัดเดียว แต่ละใบเป็นไอคอนข้างข้อความ
gridGridDef — คอลัมน์และช่องว่างต่อขั้น ตามลำดับจากน้อยไปมาก — บน cells
groupตัวหุ้มบน elements สำหรับคำใบ้ที่ใช้กับทั้งชุด
accordianตัวกระตุ้นและเนื้อหาของพวกมัน
carte-blancheแผงอิสระ อะไรก็ได้ด้านบน หัวเรื่อง อะไรก็ได้ด้านล่าง คำเรียกให้ทำที่เท้า
screenfulเต็มหนึ่งจอ แบนเนอร์ที่เลือกได้บนหนึ่งถึงสามคอลัมน์ พร้อมลำดับบนโทรศัพท์
elementโหนดที่ผู้เขียนสร้างไว้แล้ว มันไม่มีตัวเรนเดอร์ โดยตั้งใจ และนั่นคือสิ่งที่ให้หน้าของบล็อกถืออะไรก็ได้

ทุกรูปถูกส่งออกเป็นชนิดจากซับพาธเดียวกัน — HeadingBlock, CTABlock, ScreenfulBlock และที่เหลือ — ข้างนิยามที่พวกมันใช้ร่วม GridDef, ImageDef, VideoDef, LinkDef, ButtonDef LinkDef ที่มี href เป็น http หรือ mailto เป็นภายนอกเองและเปิดแท็บใหม่ด้วย rel="noreferrer noopener" ระบุ external เฉพาะที่ที่สกีมบอกเองไม่ได้

อุปกรณ์เป็นพร็อพ

ทุกตัวเรนเดอร์รับ agent คือชั้นของอุปกรณ์ แทนการอ่านมีเดียเควอรี บล็อกเหล่านี้เรนเดอร์บนเซิร์ฟเวอร์ที่ต้องปล่อยมาร์กอัปที่ถูกตั้งแต่ครั้งแรก เลย์เอาต์โทรศัพท์ที่มาเป็นมาร์กอัปเดสก์ท็อปแล้วแก้ตัวเองตอนไฮเดรตคือการกระโดดที่เห็นได้ และสำหรับบล็อกวิดีโอคือการดาวน์โหลดที่เสียเปล่า

<Content blocks={page} agent={isPhone ? 'phone' : 'desktop'} />

ชนิดของคุณเอง

แผนที่จากชนิดไปตัวเรนเดอร์คือจุดขยาย โฮสต์เพิ่มชนิดของตัวเอง หรือแทนที่หนึ่ง — ซึ่งเป็นวิธีที่แอป Next สลับภาพที่ปรับให้เหมาะ และวิธีที่สิ่งที่ไลบรารีไม่ได้ส่งไปถึงหน้า

import { registerBlockType, type BlockComponentProps } from '@hanzo/ui/blocks'

registerBlockType('quote', ({ block }: BlockComponentProps) => (
  <blockquote>{(block as { text: string }).text}</blockquote>
))

has(specifiers, token) ตอบว่าคำใบ้อยู่ในถุงหรือไม่ และ fit(dim, within) คือกล่องใหญ่สุดของอัตราส่วนหนึ่งที่อยู่ในอีกอัน ทั้งคู่ถูกส่งออกสำหรับตัวเรนเดอร์ของคุณ แคตตาล็อก บล็อก เรนเดอร์ตัวอย่างของแต่ละตัวเรนเดอร์ข้างชนิดของมัน