شارة Badge

يُستخدم LhBadge لعرض عدد الرسائل غير المقروءة أو علامات الحالة.

الاستخدام الأساسي

⁵

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge :value="5">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge :value="5">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

الحد الأقصى المخصص

⁹⁹⁺

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge
    :value="100"
    :max="99"
  >
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

النقطة الحمراء

يعرض is-dot نقطة حمراء صغيرة فقط دون قيمة رقمية، ويناسب تنبيهات نوع «توجد تحديثات»، ويمكن تغيير لونها عبر type.

رسائل

مهام

vue

<script setup lang="ts">
</script>

<template>
  <!-- نقطة حمراء -->
  <LhBadge is-dot>
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- نقطة حمراء (لون التحذير) -->
  <LhBadge is-dot type="warning">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <!-- نقطة حمراء -->
  <LhBadge is-dot>
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- نقطة حمراء (لون التحذير) -->
  <LhBadge is-dot type="warning">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

الإزاحة والقيمة الصفرية والمحتوى المخصص

يضبط offset موضع الشارة بدقة (إزاحة [x, y] بالبكسل)؛ ويجعل show-zero القيمة صفر تُعرض أيضًا؛ ويستبدل content الرقم بنص مخصص.

offset

⁵

show-zero

⁰

content

^جديد

vue

<script setup lang="ts">
</script>

<template>
  <!-- إزاحة -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- القيمة الصفرية تُعرض أيضًا -->
  <LhBadge :value="0" show-zero>
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- محتوى مخصص -->
  <LhBadge value="جديد" content="جديد">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <!-- إزاحة -->
  <LhBadge :value="5" :offset="[6, 6]">
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- القيمة الصفرية تُعرض أيضًا -->
  <LhBadge :value="0" show-zero>
    <div>المحتوى الهدف</div>
  </LhBadge>
  <!-- محتوى مخصص -->
  <LhBadge value="جديد" content="جديد">
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge is-dot>
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge is-dot>
    <div>المحتوى الهدف</div>
  </LhBadge>
</template>

الأنواع

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge
    type="primary"
    :value="2"
  >
    <div>Primary</div>
  </LhBadge>
  <LhBadge
    type="success"
    :value="1"
  >
    <div>Success</div>
  </LhBadge>
  <LhBadge
    type="warning"
    :value="1"
  >
    <div>Warning</div>
  </LhBadge>
  <LhBadge
    type="info"
    :value="1"
  >
    <div>Info</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge
    type="primary"
    :value="2"
  >
    <div>Primary</div>
  </LhBadge>
  <LhBadge
    type="success"
    :value="1"
  >
    <div>Success</div>
  </LhBadge>
  <LhBadge
    type="warning"
    :value="1"
  >
    <div>Warning</div>
  </LhBadge>
  <LhBadge
    type="info"
    :value="1"
  >
    <div>Info</div>
  </LhBadge>
</template>

الأحجام

⁵

vue

<script setup lang="ts">
</script>

<template>
  <LhBadge
    size="small"
    :value="5"
  >
    <div>Small</div>
  </LhBadge>
  <LhBadge
    size="medium"
    :value="5"
  >
    <div>Medium</div>
  </LhBadge>
  <LhBadge
    size="large"
    :value="5"
  >
    <div>Large</div>
  </LhBadge>
</template>

vue

<script>
export default {}
</script>

<template>
  <LhBadge
    size="small"
    :value="5"
  >
    <div>Small</div>
  </LhBadge>
  <LhBadge
    size="medium"
    :value="5"
  >
    <div>Medium</div>
  </LhBadge>
  <LhBadge
    size="large"
    :value="5"
  >
    <div>Large</div>
  </LhBadge>
</template>

التحكم في العرض والإخفاء

¹⁰

vue

<script setup lang="ts">
import { ref } from 'vue'

const badgeValue = ref(10)
const isHidden = ref(false)
</script>

<template>
  <LhBadge
    :value="badgeValue"
    :hidden="isHidden"
  >
    <div>المحتوى الهدف</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'إظهار' : 'إخفاء' }}
  </LhButton>
</template>

vue

<script>
import { ref } from 'vue'

const badgeValue = ref(10)
const isHidden = ref(false)
</script>

<template>
  <LhBadge
    :value="badgeValue"
    :hidden="isHidden"
  >
    <div>المحتوى الهدف</div>
  </LhBadge>
  <LhButton @click="isHidden = !isHidden">
    {{ isHidden ? 'إظهار' : 'إخفاء' }}
  </LhButton>
</template>

تعريفات الأنواع

بنى TypeScript التي يصدّرها هذا المكوّن خارجيًا (مستخرَجة تلقائيًا من packages/components/badge/src/types.ts و@lh-ui/share/core/*؛ انقر كل عنصر لعرض التعريف كاملًا؛ وصف الخصائص في جدول الخصائص أدناه):

LhBadgeProps

export interface LhBadgeProps {
  type?: LhBadgeType
  value?: string | number
  size?: LhBadgeSize
  max?: number
  isDot?: boolean
  hidden?: boolean
  offset?: [number, number]
  showZero?: boolean
  content?: string
  /** خصائص التخطيط السريع sx */
  sx?: LhSxProps
}

LhBadgeSize

export type LhBadgeSize = LhComponentSize

LhBadgeOffset

export type LhBadgeOffset = [number, number]

LhBadgeType _{(مأخوذ من @lh-ui/share/core/badge)}

export type LhBadgeType = 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'default'

LhComponentSize _{(مأخوذ من @lh-ui/share/core/shared)}

export type LhComponentSize = (typeof LH_SIZE_CONST)[keyof typeof LH_SIZE_CONST]

التدويل

يمكن تدويل نص الشارة عبر LhConfigProvider مع حزم اللغات.

消息

⁵

vue

<script setup lang="ts">
import { ref } from 'vue'
import { LhConfigProvider, LhBadge, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

const locale = ref('zh-CN')
</script>

<template>
  <!-- تبديل حزمة اللغة عبر ConfigProvider -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhBadge :value="5">
      <div>{{ locale === 'zh-CN' ? '消息' : 'Messages' }}</div>
    </LhBadge>
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

vue

<script>
import { LhConfigProvider, LhBadge, LhButton } from '@lh-ui/vue3'
import { zhCN } from '@lh-ui/vue3'
import { enUS } from '@lh-ui/vue3'

export default {
  components: { LhConfigProvider, LhBadge, LhButton },
  data() {
    return {
      locale: 'zh-CN',
      zhCN: zhCN,
      enUS: enUS,
    }
  },
}
</script>

<template>
  <!-- تبديل حزمة اللغة عبر ConfigProvider -->
  <LhConfigProvider :locale="locale === 'zh-CN' ? zhCN : enUS">
    <LhBadge :value="5">
      <div>{{ locale === 'zh-CN' ? '消息' : 'Messages' }}</div>
    </LhBadge>
    <LhButton @click="locale = locale === 'zh-CN' ? 'en-US' : 'zh-CN'">
      {{ locale === 'zh-CN' ? '切换英文' : 'Switch to Chinese' }}
    </LhButton>
  </LhConfigProvider>
</template>

API

الخاصية	الوصف	النوع	الافتراضي
type	نوع الشارة	`"primary" \| "success" \| "warning" \| "danger" \| "info" \| "default"`	`'danger'`
value	القيمة المعروضة	`string \| number`	—
size	الحجم	`"small" \| "medium" \| "large" \| "mini" \| "x-large"`	`'medium'`
max	الحد الأقصى	`number`	`99`
isDot	وضع النقطة الصغيرة	`boolean`	`false`
hidden	ما إذا كانت مخفية	`boolean`	`false`
offset	مقدار الإزاحة	`[number, number]`	—
showZero	ما إذا كانت القيمة 0 تُعرض	`boolean`	`false`
content	محتوى مخصص	`string`	—
sx	خصائص التخطيط السريع (مثل `{ mt: 2, w: '50%' }`)، تُحوّل إلى أنماط سطرية تُطبَّق على العنصر الجذري	`LhSxProps`	—

إمكانية الوصول

شارة وضع النقطة الصغيرة (is-dot) زخرفة بحتة، تُعلَّم بـ aria-hidden ولا تدخل شجرة إمكانية الوصول
يحتفظ وضع القيمة بالمحتوى النصي، بحيث يمكن لقارئ الشاشة قراءة العدّ مثل «99+»

شارة Badge ​

الاستخدام الأساسي ​

الحد الأقصى المخصص ​

النقطة الحمراء ​

الإزاحة والقيمة الصفرية والمحتوى المخصص ​

الأنواع ​

الأحجام ​

التحكم في العرض والإخفاء ​

تعريفات الأنواع ​

التدويل ​

API ​

إمكانية الوصول ​