API başvurusu

@kkwaenggwari/animated-chorus'un her export'u; props, tip ve varsayılanlarıyla. Aynı adlar web'de ve React Native'de çalışır.

17 API

Sayılar ve metin

MotionNumber

Basamakları tekerlek gibi dönen bir sayı.

PropTipVarsayılanAçıklama
valuenumber | bigint | string—zorunluSayı ya da çağıranın biçimlendirdiği sayısal metin.
mode'replace' | 'roll''replace'replace değişen her basamağı bir adım taşır; roll aradaki rakamlardan geçer.
direction'auto' | 'digit' | 'up' | 'down''auto'auto boyuttaki değişikliği izler, eldeler tek yönde döner; digit her basamağı kendi içinde karşılaştırır.
staggernumber45Değişen basamaklar arasındaki milisaniye, birler basamağından dışa doğru. Dalganın tamamı sınırlıdır.
format(value) => string | Intl.NumberFormatOptionsGösterilecek metni döndüren bir fonksiyon ya da Intl.NumberFormat seçenekleri (intl ile).
intlbooleanfalseYerleşik Intl.NumberFormat'ı kullanır. Hiçbir çalışma zamanının Intl gerektirmemesi için varsayılan olarak kapalıdır.
localestring | string[]intl için yerel ayar.
prefixstringSayıdan önceki metin.
suffixstringSayıdan sonraki metin.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
onMotionComplete(value) => voidBasamaklar yerleşince değerle çalışır.
Bileşen sayfası ve tezgâh

MotionText

Değiştiğinde canlanan metin: sayısal metin basamak basamak döner, diğer metin değiş tokuş edilir.

PropTipVarsayılanAçıklama
childrenReactNodeGösterilecek metin.
aselement'span'Render edilecek öğe.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
onMotionComplete(text) => voidHareket yerleşince çalışır.
Bileşen sayfası ve tezgâh

MotionStream

Patlamalara yetişen, sabit bir hızla gösterilen akan metin.

PropTipVarsayılanAçıklama
textstring—zorunluŞimdiye kadarki metin. Büyüyen metin sabit hızla gösterilir; yeniden yazım ortak başlangıçtan devam eder.
speednumber90Saniyedeki karakter cinsinden temel gösterim hızı.
catchUpnumber900Birikme, hızlanarak yaklaşık bu kadar milisaniyede gösterilir.
initialbooleanfalseBağlanırken var olan metni de kademeli göster (aksi hâlde hemen görünür).
effect'fade' | 'none''fade'fade yeni karakterleri belirterek getirir; none doğrudan gösterir.
children(visible: string) => ReactNodeHızı ayarlanmış metni alan bir fonksiyon; örneğin Markdown render etmek için.
aselement'span'Render edilecek öğe.
onMotionComplete(text) => voidGösterim text'e her yetiştiğinde çalışır.
Bileşen sayfası ve tezgâh

İçerik ve boyut

MotionSwap

Öğe yeniden boyutlanırken çapraz geçişle değişen içerik.

PropTipVarsayılanAçıklama
valueunknownİçeriğin kimliği; yeni bir değer değişimi tetikler. Düz metin çocuklar kendi kimlikleridir.
childrenReactNodeİçerik.
aselement'span'Render edilecek öğe.
inlinebooleanas === 'span'true içeriğe göre boyutlanır (etiketler, simgeler); false üst öğenin genişliğini doldurur ve yüksekliği canlandırır.
align'start' | 'center' | 'end''center'Boyut değişirken içeriğin konumu.
effect'fade' | 'up' | 'down' | 'scale''fade'İçeriğin nasıl girip çıktığı: up yükselir, down düşer, scale büyür.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
onMotionComplete(value) => voidHareket yerleşince çalışır.
Bileşen sayfası ve tezgâh

MotionHeight

Yüksekliği içeriğe göre canlandırır: daralma, genişleme ve içerik değişiklikleri.

PropTipVarsayılanAçıklama
openbooleantruefalse sıfır yüksekliğe daraltır; içerik bağlı ama gizli ve etkisiz kalır.
childrenReactNodeİçerik.
aselement'div'Render edilecek öğe.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
onMotionComplete(open) => voidYükseklik yerleşince open ile çalışır.
Bileşen sayfası ve tezgâh

MotionPresence

İçeriği girip çıkarken bağlı tutar.

PropTipVarsayılanAçıklama
presentboolean—zorunluİçeriği gösterir ya da gizler. Ayırmak yerine bunu değiştirin.
enterPose{ opacity: 1, translateY: 0 }Durgun hâldeki pose.
exitPose{ opacity: 0, translateY: -12 }İçeriğin ayrılırken aldığı ve girerken başladığı pose.
aselement'div'Render edilecek öğe.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
onExitComplete() => voidİçerik ayrılıp kaldırıldıktan sonra çalışır.
Bileşen sayfası ve tezgâh

Seçim ve sayfalama

MotionHighlight

Seçili öğeye doğru ilerleyen tek bir vurguyla veriden gelen öğeler.

PropTipVarsayılanAçıklama
itemsreadonly T[]—zorunluVeri diziniz.
valuekey | null—zorunluVurgulanan öğenin key'i; null vurguyu gizler.
onValueChange(key, item) => voidBir öğeye basıldığında key ve öğeyle çalışır.
getKey(item) => string | numberitem.idBir öğe için benzersiz, kararlı bir key döndürür. Varsayılan item.id, dize ve sayılar için öğenin kendisidir.
renderItem(item, { selected, index }) => ReactNodeitem.labelBir öğeyi çizer; seçili olup olmadığını alır.
hoverbooleanfalseÖğelerin üzerinde işaretçiyi izler ve ayrılınca value'ya döner (web).
itemAselement'button'Her öğenin elemanı.
itemClassNamestringHer öğe elemanı için class; itemStyle satır içi stilini ayarlar.
highlightClassNamestringVurgu için class; highlightStyle satır içi stilini ayarlar.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

MotionPager

Veriden kaydırılabilir sayfalar.

PropTipVarsayılanAçıklama
itemsreadonly T[]—zorunluVeri diziniz.
indexnumberGösterilen sayfa. Sayfa çeviricinin kendi sayfasını tutması için boş bırakın.
defaultIndexnumber0index denetimli değilken başlangıç sayfası.
onIndexChange(index, item) => voidBir kaydırma, tuş ya da tekerlek hareketi yerleşir yerleşmez index ve öğeyle çalışır.
getKey(item) => string | numberitem.idBir öğe için benzersiz, kararlı bir key döndürür. Varsayılan item.id, dize ve sayılar için öğenin kendisidir.
renderItem(item, { index, active }) => ReactNodeitem.labelBir sayfayı çizer; index'ini ve etkin olup olmadığını alır.
gapnumber0Sayfalar arasındaki boşluk, piksel.
itemClassNamestringHer öğe elemanı için class; itemStyle satır içi stilini ayarlar.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

Listeler

MotionList

Veriden, yalnızca değişeni canlandıran key'li bir liste.

PropTipVarsayılanAçıklama
itemsreadonly T[]—zorunluVeri diziniz.
getKey(item) => string | numberitem.idBir öğe için benzersiz, kararlı bir key döndürür. Varsayılan item.id, dize ve sayılar için öğenin kendisidir.
renderItem(item, index) => ReactNodeitem.labelBir öğeyi çizer.
aselement'div'Render edilecek öğe.
itemAselement'li' | 'div'Her öğenin elemanı.
itemClassNamestringHer öğe elemanı için class; itemStyle satır içi stilini ayarlar.
effect'rise' | 'fade' | 'scale' | 'slide''rise'Öğelerin nasıl girip çıktığı.
distancenumber16rise ve slide için piksel cinsinden yol.
staggernumber40Giren öğeler arasındaki milisaniye.
order'forward' | 'reverse''forward'Kademenin yönü.
presentbooleantruefalse düzeni koruyarak her öğeyi canlanarak çıkarır; true onları geri getirir.
initialbooleantrueListe bağlandığında girişi oynatır.
playKeystring | numberDeğiştirmek girişi yeniden oynatır.
transitionTransitionspringGiren ve çıkan öğeler için geçiş.
layoutTransitionTransitionspringYeni konumlara süzülen öğeler için geçiş.
Bileşen sayfası ve tezgâh

MotionReorder

Bir listeyi ya da ızgarayı sürükleyerek yeniden sıralayın; klavyeyle taşıma dahil.

PropTipVarsayılanAçıklama
itemsreadonly T[]Sırayı siz denetlediğinizde öğeler.
defaultItemsreadonly T[][]Sırayı bileşen tuttuğunda başlangıç öğeleri.
onItemsChange(items, { reason, key }) => voidYeni sırayla ve bunun sürüklemeden, bırakmadan ya da klavyeden gelip gelmediğiyle çalışır.
getKey(item) => string | numberitemBir öğe için benzersiz bir key döndürür. Varsayılan öğenin kendisidir.
renderItem(item, { index, dragging }) => ReactNodeitem.labelBir öğeyi çizer; index'ini ve sürüklenip sürüklenmediğini alır.
reorder'live' | 'drop''live'live sürüklerken diğer öğeleri hareket ettirir; drop bırakmayı bekler.
layout'list' | 'grid''grid'list ya da grid.
columnsnumber3Izgaradaki sütunlar.
gapnumber12Öğeler arasındaki boşluk, piksel.
disabledbooleanfalseSürüklemeyi kapatır.
durationnumber260Yol veren öğeler için milisaniye.
itemClassNamestringHer öğe elemanı için class; itemStyle satır içi stilini ayarlar.
Bileşen sayfası ve tezgâh

Hareketler

MotionSwipe

Yatay kaydırmayla eylemleri gösteren ve kaydırarak atılabilen bir satır.

PropTipVarsayılanAçıklama
childrenReactNodeSatır içeriği.
startActionsReactNodeSatır sona doğru sürüklendiğinde satır başında gösterilir.
endActionsReactNodeSatır başa doğru sürüklendiğinde satır sonunda gösterilir.
dismiss'start' | 'end' | 'both'Uzun bir kaydırmanın ya da fırlatmanın satırı kaldırdığı taraflar.
onDismiss(side) => voidSatır dışarı kayıp daraldıktan sonra çalışır; öğeyi verinizden burada kaldırın.
onOpenChange(side | null) => voidAçık tarafla ya da satır kapanınca null ile çalışır.
disabledbooleanfalseKaydırmayı kapatır.
contentClassNamestringSatır içeriği için class; contentStyle satır içi stilini ayarlar.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

MotionHold

Onaylamak için basılı tutun; erken bırakmak geri sarar.

PropTipVarsayılanAçıklama
childrenReactNodeDüğme etiketi.
onConfirm() => voidBasılı tutma tamamlanınca çalışır.
durationnumber1200Basmanın tutulması gereken milisaniye.
disabledbooleanfalseDüğmeyi kapatır.
fillClassNamestringBüyüyen dolgu için class; fillStyle satır içi stilini ayarlar.
Bileşen sayfası ve tezgâh

Katmanlar

MotionSheet

Durma noktalarıyla alt sheet, üst sheet ya da yan çekmece.

PropTipVarsayılanAçıklama
openbooleanfalseSheet'in gösterilip gösterilmediği.
onOpenChange(open) => voidSheet sürüklenerek, dokunularak ya da Escape ile kapatıldığında false ile çalışır.
detents(number | 'content')[]['content']Durgun boyutlar: ekranın bir kesri, piksel ya da 'content'.
detentnumberDenetimli durma noktası index'i.
defaultDetentnumber0detent olmadan açarken kullanılan durma noktası index'i.
onDetentChange(index) => voidSheet'in yerleştiği durma noktasının index'iyle çalışır.
side'bottom' | 'top' | 'start' | 'end''bottom'Sheet'in geldiği kenar.
modalbooleantrueBir arka plan ekler, odağı içinde tutar ve sayfayı etkisiz kılar.
dismissiblebooleantrueEn küçük durma noktasının ötesine sürüklemek, arka plan ve Escape onu kapatır.
backdropClassNamestringArka plan için class; backdropStyle satır içi stilini ayarlar.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

MotionZoom

Bulunduğu yerden ekranı dolduracak şekilde yakınlaşan bir görsel.

PropTipVarsayılanAçıklama
srcstringYerinde gösterilen görsel.
zoomSrcstringYüklenince gösterilen daha büyük görsel; aynı en boy oranını koruyun.
marginnumber24Yakınlaştırılan görselin çevresinde bırakılan boşluk, piksel.
disabledbooleanfalseYakınlaştırmayı kapatır.
onZoomChange(zoomed) => voidYakınlaştırılınca true, kapanınca false ile çalışır.
backdropStyleCSSPropertiesArka plan için satır içi stil.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

İlerleme

ProgressBar

Belirsiz durumlu, denetimli bir ilerleme çizgisi.

PropTipVarsayılanAçıklama
valuenumber | null0'dan max'a ilerleme; null belirsizdir.
maxnumber100Tamamlandı anlamına gelen değer.
colorstring'currentColor'Dolgu rengi.
trackColorstring'#e7ece9'Ray rengi.
thicknessnumber8Piksel cinsinden çizgi kalınlığı.
direction'ltr' | 'rtl''ltr'Soldan (ltr) ya da sağdan (rtl) doldurur.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

ProgressRing

Belirsiz durumlu, denetimli bir ilerleme halkası.

PropTipVarsayılanAçıklama
valuenumber | null0'dan max'a ilerleme; null belirsizdir.
maxnumber100Tamamlandı anlamına gelen değer.
sizenumber96Piksel cinsinden çap.
thicknessnumber8Piksel cinsinden halka kalınlığı.
colorstring'currentColor'Yay rengi.
trackColorstring'#e7ece9'Ray rengi.
childrenReactNodeOrtada gösterilen etiket.
transitionTransitionspringBir timing eğrisi { duration, easing } ya da bir yay { tempo: 'spring', spring }. Yaylar kesildiğinde momentumlarını korur.
Bileşen sayfası ve tezgâh

Geçişler

motionTokens

Herhangi bir transition prop'u için hazır değerler.

PropTipVarsayılanAçıklama
duration{ instant, fast, normal, slow }0 · 140 · 280 · 520Milisaniye cinsinden süreler.
easing{ ease, easeOut, expoOut, backOut }TransitionSüre ve adlandırılmış eğri içeren timing geçişleri.
spring{ quick, basic, gentle, bouncy }TransitionHızlı ve sıkıdan yumuşak ve sekene kadar yay geçişleri.
Geçişler
App.jsx
// Web and React Native: the same import.
import { MotionNumber, MotionList } from '@kkwaenggwari/animated-chorus';

export function Score({ points, players }) {
  return (
    <>
      <MotionNumber value={points} />
      <MotionList items={players} renderItem={(player) => player.name} />
    </>
  );
}

Ara

Belgelerde aramak için yazın.