API రిఫరెన్స్

@kkwaenggwari/animated-chorus యొక్క ప్రతి export దాని props, టైప్‌లు, డిఫాల్ట్‌లతో. అవే పేర్లు వెబ్‌లో, React Native-లో పనిచేస్తాయి.

17 API-లు

సంఖ్యలు, టెక్స్ట్

MotionNumber

స్థానాలు చక్రాల్లా దొర్లే సంఖ్య.

Propటైప్డిఫాల్ట్వివరణ
valuenumber | bigint | string—తప్పనిసరిసంఖ్య, లేదా కాలర్ ఫార్మాట్ చేసిన సంఖ్యా టెక్స్ట్.
mode'replace' | 'roll''replace'replace మారిన ప్రతి స్థానాన్ని ఒక అడుగు కదిలిస్తుంది; roll మధ్యలోని అంకెల గుండా వెళ్తుంది.
direction'auto' | 'digit' | 'up' | 'down''auto'auto పరిమాణ మార్పును అనుసరిస్తుంది, అందువల్ల క్యారీలు ఒకే దిశలో దొర్లుతాయి; digit ప్రతి స్థానాన్ని విడిగా పోలుస్తుంది.
staggernumber45మారిన స్థానాల మధ్య మిల్లీసెకన్లు, ఒకట్ల స్థానం నుండి బయటకు. మొత్తం అల పరిమితం.
format(value) => string | Intl.NumberFormatOptionsచూపించాల్సిన టెక్స్ట్‌ను ఇచ్చే ఫంక్షన్, లేదా Intl.NumberFormat ఆప్షన్లు (intl‌తో).
intlbooleanfalseఅంతర్నిర్మిత Intl.NumberFormat వాడండి. ఏ రన్‌టైమ్‌కూ Intl అవసరం లేకుండా డిఫాల్ట్‌గా ఆఫ్.
localestring | string[]intl కోసం locale.
prefixstringసంఖ్యకు ముందు టెక్స్ట్.
suffixstringసంఖ్యకు తర్వాత టెక్స్ట్.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
onMotionComplete(value) => voidస్థానాలు స్థిరపడిన తర్వాత విలువతో నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionText

మారినప్పుడు యానిమేట్ అయ్యే టెక్స్ట్: సంఖ్యా టెక్స్ట్ స్థానాల వారీగా దొర్లుతుంది, ఇతర టెక్స్ట్ మార్చబడుతుంది.

Propటైప్డిఫాల్ట్వివరణ
childrenReactNodeచూపించాల్సిన టెక్స్ట్.
aselement'span'రెండర్ చేయాల్సిన ఎలిమెంట్.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
onMotionComplete(text) => voidమోషన్ స్థిరపడినప్పుడు నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionStream

పేలుళ్లను అందుకునే స్థిరమైన వేగంతో బయటపడే స్ట్రీమ్ టెక్స్ట్.

Propటైప్డిఫాల్ట్వివరణ
textstring—తప్పనిసరిఇప్పటివరకు ఉన్న టెక్స్ట్. పెరిగే టెక్స్ట్ స్థిరమైన వేగంతో బయటపడుతుంది; తిరిగి రాయడం ఉమ్మడి ప్రారంభం నుండి కొనసాగుతుంది.
speednumber90సెకనుకు అక్షరాలలో ఆధార బయటపాటు రేటు.
catchUpnumber900బ్యాక్‌లాగ్ వేగవంతమై సుమారు ఇన్ని మిల్లీసెకన్లలో బయటపడుతుంది.
initialbooleanfalseమౌంట్‌లో ఉన్న టెక్స్ట్‌ను కూడా బయటపెట్టండి (లేకపోతే అది వెంటనే చూపబడుతుంది).
effect'fade' | 'none''fade'fade కొత్త అక్షరాలను మసకగా తెస్తుంది; none వాటిని నేరుగా చూపిస్తుంది.
children(visible: string) => ReactNodeవేగం నియంత్రించిన టెక్స్ట్‌ను పొందే ఫంక్షన్, ఉదాహరణకు Markdown రెండర్ చేయడానికి.
aselement'span'రెండర్ చేయాల్సిన ఎలిమెంట్.
onMotionComplete(text) => voidబయటపాటు text-ను అందుకున్న ప్రతిసారీ నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

విషయం, పరిమాణం

MotionSwap

ఎలిమెంట్ పరిమాణం మారుతుండగా క్రాస్-ఫేడ్ అయ్యే విషయం.

Propటైప్డిఫాల్ట్వివరణ
valueunknownవిషయం గుర్తింపు; కొత్త విలువ మారుస్తుంది. సాధారణ టెక్స్ట్ పిల్లలు తమకు తామే గుర్తింపు.
childrenReactNodeవిషయం.
aselement'span'రెండర్ చేయాల్సిన ఎలిమెంట్.
inlinebooleanas === 'span'true విషయానికి తగిన పరిమాణం తీసుకుంటుంది (లేబుల్‌లు, ఐకాన్‌లు); false పేరెంట్ వెడల్పును నింపి ఎత్తును యానిమేట్ చేస్తుంది.
align'start' | 'center' | 'end''center'పరిమాణం మారుతున్నప్పుడు విషయం ఉండే చోటు.
effect'fade' | 'up' | 'down' | 'scale''fade'విషయం ఎలా ప్రవేశించి నిష్క్రమిస్తుంది: up పైకి లేస్తుంది, down పడుతుంది, scale పెరుగుతుంది.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
onMotionComplete(value) => voidమోషన్ స్థిరపడినప్పుడు నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionHeight

ఎత్తును విషయానికి యానిమేట్ చేస్తుంది: కుదించు, విస్తరించు, విషయ మార్పులు.

Propటైప్డిఫాల్ట్వివరణ
openbooleantruefalse సున్నా ఎత్తుకు కుదిస్తుంది; విషయం మౌంట్ అయి, దాగి, నిష్క్రియంగా ఉంటుంది.
childrenReactNodeవిషయం.
aselement'div'రెండర్ చేయాల్సిన ఎలిమెంట్.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
onMotionComplete(open) => voidఎత్తు స్థిరపడిన తర్వాత open‌తో నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionPresence

విషయం లోపలికి వచ్చి బయటకు వెళ్లే యానిమేషన్ సమయంలో దాన్ని మౌంట్ అయి ఉంచుతుంది.

Propటైప్డిఫాల్ట్వివరణ
presentboolean—తప్పనిసరివిషయాన్ని చూపించండి లేదా దాచండి. అన్‌మౌంట్ చేసే బదులు దీన్ని మార్చండి.
enterPose{ opacity: 1, translateY: 0 }విశ్రాంతి స్థితిలోని pose.
exitPose{ opacity: 0, translateY: -12 }విషయం నిష్క్రమించే, ప్రవేశించే pose.
aselement'div'రెండర్ చేయాల్సిన ఎలిమెంట్.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
onExitComplete() => voidవిషయం నిష్క్రమించి తీసివేయబడిన తర్వాత నడుస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

ఎంపిక, పేజింగ్

MotionHighlight

ఎంచుకున్న అంశానికి ప్రయాణించే ఒకే హైలైట్‌తో డేటా నుండి అంశాలు.

Propటైప్డిఫాల్ట్వివరణ
itemsreadonly T[]—తప్పనిసరిమీ డేటా అరే.
valuekey | null—తప్పనిసరిహైలైట్ చేసిన అంశం key; null హైలైట్‌ను దాస్తుంది.
onValueChange(key, item) => voidఅంశం నొక్కినప్పుడు key, అంశంతో నడుస్తుంది.
getKey(item) => string | numberitem.idఒక అంశానికి ప్రత్యేకమైన, స్థిరమైన key ఇస్తుంది. డిఫాల్ట్‌గా item.id, లేదా స్ట్రింగ్‌లు, సంఖ్యలకు అంశమే.
renderItem(item, { selected, index }) => ReactNodeitem.labelఒక అంశాన్ని గీస్తుంది; అది ఎంచుకోబడిందా లేదా అని పొందుతుంది.
hoverbooleanfalseఅంశాలపై పాయింటర్‌ను అనుసరించి, బయటకు వెళ్లినప్పుడు value-కు తిరిగి రండి (వెబ్).
itemAselement'button'ప్రతి అంశానికి ఎలిమెంట్.
itemClassNamestringప్రతి అంశ ఎలిమెంట్‌కు class; itemStyle దాని inline style సెట్ చేస్తుంది.
highlightClassNamestringహైలైట్‌కు class; highlightStyle దాని inline style సెట్ చేస్తుంది.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionPager

డేటా నుండి స్వైప్ చేయగల పేజీలు.

Propటైప్డిఫాల్ట్వివరణ
itemsreadonly T[]—తప్పనిసరిమీ డేటా అరే.
indexnumberచూపబడే పేజీ. పేజర్ స్వయంగా ఉంచుకోవడానికి దీన్ని వదిలేయండి.
defaultIndexnumber0index నియంత్రించబడనప్పుడు ప్రారంభ పేజీ.
onIndexChange(index, item) => voidస్వైప్, కీ లేదా వీల్ సంజ్ఞ స్థిరపడిన వెంటనే index, అంశంతో నడుస్తుంది.
getKey(item) => string | numberitem.idఒక అంశానికి ప్రత్యేకమైన, స్థిరమైన key ఇస్తుంది. డిఫాల్ట్‌గా item.id, లేదా స్ట్రింగ్‌లు, సంఖ్యలకు అంశమే.
renderItem(item, { index, active }) => ReactNodeitem.labelఒక పేజీని గీస్తుంది; దాని index, అది సక్రియమా అని పొందుతుంది.
gapnumber0పేజీల మధ్య ఖాళీ, పిక్సెల్‌లలో.
itemClassNamestringప్రతి అంశ ఎలిమెంట్‌కు class; itemStyle దాని inline style సెట్ చేస్తుంది.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

జాబితాలు

MotionList

మారినదాన్ని మాత్రమే యానిమేట్ చేసే, డేటా నుండి key ఉన్న జాబితా.

Propటైప్డిఫాల్ట్వివరణ
itemsreadonly T[]—తప్పనిసరిమీ డేటా అరే.
getKey(item) => string | numberitem.idఒక అంశానికి ప్రత్యేకమైన, స్థిరమైన key ఇస్తుంది. డిఫాల్ట్‌గా item.id, లేదా స్ట్రింగ్‌లు, సంఖ్యలకు అంశమే.
renderItem(item, index) => ReactNodeitem.labelఒక అంశాన్ని గీస్తుంది.
aselement'div'రెండర్ చేయాల్సిన ఎలిమెంట్.
itemAselement'li' | 'div'ప్రతి అంశానికి ఎలిమెంట్.
itemClassNamestringప్రతి అంశ ఎలిమెంట్‌కు class; itemStyle దాని inline style సెట్ చేస్తుంది.
effect'rise' | 'fade' | 'scale' | 'slide''rise'అంశాలు ఎలా ప్రవేశించి నిష్క్రమిస్తాయి.
distancenumber16rise, slide ప్రయాణ దూరం, పిక్సెల్‌లలో.
staggernumber40ప్రవేశించే అంశాల మధ్య మిల్లీసెకన్లు.
order'forward' | 'reverse''forward'Stagger దిశ.
presentbooleantruefalse లేఅవుట్‌ను నిలుపుకుంటూ ప్రతి అంశాన్ని యానిమేట్ చేసి బయటకు పంపుతుంది; true వాటిని తిరిగి తెస్తుంది.
initialbooleantrueజాబితా మౌంట్ అయినప్పుడు ప్రవేశాన్ని ప్లే చేయండి.
playKeystring | numberదీన్ని మార్చితే ప్రవేశం మళ్లీ ప్లే అవుతుంది.
transitionTransitionspringప్రవేశించే, నిష్క్రమించే అంశాలకు ట్రాన్సిషన్.
layoutTransitionTransitionspringకొత్త స్థానాలకు జారే అంశాలకు ట్రాన్సిషన్.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionReorder

కీబోర్డ్ కదలికలతో, జాబితా లేదా గ్రిడ్‌ను లాగి క్రమం మార్చండి.

Propటైప్డిఫాల్ట్వివరణ
itemsreadonly T[]క్రమాన్ని మీరు నియంత్రించినప్పుడు అంశాలు.
defaultItemsreadonly T[][]క్రమాన్ని కాంపోనెంట్ ఉంచుకున్నప్పుడు ప్రారంభ అంశాలు.
onItemsChange(items, { reason, key }) => voidకొత్త క్రమంతో, అది లాగడం, విడవడం లేదా కీబోర్డ్ నుండి వచ్చిందా అనే దానితో నడుస్తుంది.
getKey(item) => string | numberitemఒక అంశానికి ప్రత్యేకమైన key ఇస్తుంది. డిఫాల్ట్‌గా అంశమే.
renderItem(item, { index, dragging }) => ReactNodeitem.labelఒక అంశాన్ని గీస్తుంది; దాని index, అది లాగబడుతోందా అని పొందుతుంది.
reorder'live' | 'drop''live'live లాగుతున్నప్పుడు ఇతర అంశాలను కదిలిస్తుంది; drop విడిచే వరకు వేచి ఉంటుంది.
layout'list' | 'grid''grid'list లేదా grid.
columnsnumber3గ్రిడ్‌లో నిలువు వరుసలు.
gapnumber12అంశాల మధ్య ఖాళీ, పిక్సెల్‌లలో.
disabledbooleanfalseలాగడాన్ని ఆఫ్ చేస్తుంది.
durationnumber260దారి ఇచ్చే అంశాలకు మిల్లీసెకన్లు.
itemClassNamestringప్రతి అంశ ఎలిమెంట్‌కు class; itemStyle దాని inline style సెట్ చేస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

సంజ్ఞలు

MotionSwipe

అడ్డ స్వైప్‌తో చర్యలను బయటపెట్టే, స్వైప్ చేసి తీసివేయగల వరుస.

Propటైప్డిఫాల్ట్వివరణ
childrenReactNodeవరుస విషయం.
startActionsReactNodeవరుస చివర వైపు లాగినప్పుడు ఇన్‌లైన్ ప్రారంభంలో బయటపడుతుంది.
endActionsReactNodeవరుస ప్రారంభం వైపు లాగినప్పుడు ఇన్‌లైన్ చివరలో బయటపడుతుంది.
dismiss'start' | 'end' | 'both'పొడవైన స్వైప్ లేదా విసురు వరుసను తీసివేసే వైపులు.
onDismiss(side) => voidవరుస బయటకు జారి కుదించుకున్న తర్వాత నడుస్తుంది; ఇక్కడ మీ డేటా నుండి అంశాన్ని తీసివేయండి.
onOpenChange(side | null) => voidతెరిచిన వైపుతో, లేదా వరుస మూసుకున్నప్పుడు null‌తో నడుస్తుంది.
disabledbooleanfalseస్వైప్‌ను ఆఫ్ చేస్తుంది.
contentClassNamestringవరుస విషయానికి class; contentStyle దాని inline style సెట్ చేస్తుంది.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionHold

నిర్ధారించడానికి నొక్కి పట్టుకోండి; ముందుగా విడిస్తే వెనక్కి తిరుగుతుంది.

Propటైప్డిఫాల్ట్వివరణ
childrenReactNodeబటన్ లేబుల్.
onConfirm() => voidపట్టుకోవడం పూర్తయిన తర్వాత ఒకసారి నడుస్తుంది.
durationnumber1200నొక్కుడు పట్టుకోవాల్సిన మిల్లీసెకన్లు.
disabledbooleanfalseబటన్‌ను ఆఫ్ చేస్తుంది.
fillClassNamestringపెరిగే నింపుకు class; fillStyle దాని inline style సెట్ చేస్తుంది.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

ఓవర్‌లేలు

MotionSheet

Detent-లతో దిగువ షీట్, పై షీట్ లేదా పక్క డ్రాయర్.

Propటైప్డిఫాల్ట్వివరణ
openbooleanfalseషీట్ చూపబడుతోందా లేదా.
onOpenChange(open) => voidషీట్ లాగడం, ట్యాప్ లేదా Escape‌తో మూసుకున్నప్పుడు false‌తో నడుస్తుంది.
detents(number | 'content')[]['content']విశ్రాంతి పరిమాణాలు: స్క్రీన్ భిన్నం, పిక్సెల్‌లు, లేదా 'content'.
detentnumberనియంత్రిత detent index.
defaultDetentnumber0detent లేకుండా తెరిచినప్పుడు వాడే detent index.
onDetentChange(index) => voidషీట్ స్థిరపడే detent index‌తో నడుస్తుంది.
side'bottom' | 'top' | 'start' | 'end''bottom'షీట్ వచ్చే అంచు.
modalbooleantrueబ్యాక్‌డ్రాప్ జోడించి, ఫోకస్‌ను లోపల ఉంచి, పేజీని నిష్క్రియం చేస్తుంది.
dismissiblebooleantrueఅతి చిన్న detent దాటి లాగడం, బ్యాక్‌డ్రాప్, Escape దాన్ని మూసివేస్తాయి.
backdropClassNamestringబ్యాక్‌డ్రాప్‌కు class; backdropStyle దాని inline style సెట్ చేస్తుంది.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

MotionZoom

ఉన్న చోటు నుండి స్క్రీన్‌ను నింపేలా జూమ్ అయ్యే చిత్రం.

Propటైప్డిఫాల్ట్వివరణ
srcstringస్థానంలో చూపబడే చిత్రం.
zoomSrcstringలోడ్ అయిన తర్వాత చూపబడే పెద్ద చిత్రం; అదే నిష్పత్తి ఉంచండి.
marginnumber24జూమ్ అయిన చిత్రం చుట్టూ ఉంచే ఖాళీ, పిక్సెల్‌లలో.
disabledbooleanfalseజూమ్‌ను ఆఫ్ చేస్తుంది.
onZoomChange(zoomed) => voidజూమ్ అయినప్పుడు true, మూసినప్పుడు false‌తో నడుస్తుంది.
backdropStyleCSSPropertiesబ్యాక్‌డ్రాప్‌కు inline style.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

పురోగతి

ProgressBar

అనిశ్చిత స్థితితో నియంత్రిత పురోగతి రేఖ.

Propటైప్డిఫాల్ట్వివరణ
valuenumber | null0 నుండి max వరకు పురోగతి; null అనిశ్చితం.
maxnumber100పూర్తి అని అర్థం వచ్చే విలువ.
colorstring'currentColor'నింపు రంగు.
trackColorstring'#e7ece9'ట్రాక్ రంగు.
thicknessnumber8రేఖ మందం, పిక్సెల్‌లలో.
direction'ltr' | 'rtl''ltr'ఎడమ నుండి (ltr) లేదా కుడి నుండి (rtl) నింపండి.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

ProgressRing

అనిశ్చిత స్థితితో నియంత్రిత పురోగతి వలయం.

Propటైప్డిఫాల్ట్వివరణ
valuenumber | null0 నుండి max వరకు పురోగతి; null అనిశ్చితం.
maxnumber100పూర్తి అని అర్థం వచ్చే విలువ.
sizenumber96వ్యాసం, పిక్సెల్‌లలో.
thicknessnumber8వలయం మందం, పిక్సెల్‌లలో.
colorstring'currentColor'చాపం రంగు.
trackColorstring'#e7ece9'ట్రాక్ రంగు.
childrenReactNodeమధ్యలో చూపబడే లేబుల్.
transitionTransitionspringటైమింగ్ వక్రం { duration, easing } లేదా spring { tempo: 'spring', spring }. spring-లు అంతరాయం కలిగినప్పుడు తమ జడత్వాన్ని నిలుపుకుంటాయి.
కాంపోనెంట్ పేజీ, వర్క్‌బెంచ్

ట్రాన్సిషన్‌లు

motionTokens

ఏ transition కోసమైనా సిద్ధమైన విలువలు.

Propటైప్డిఫాల్ట్వివరణ
duration{ instant, fast, normal, slow }0 · 140 · 280 · 520మిల్లీసెకన్లలో వ్యవధులు.
easing{ ease, easeOut, expoOut, backOut }Transitionవ్యవధి, పేరున్న వక్రంతో టైమింగ్ ట్రాన్సిషన్‌లు.
spring{ quick, basic, gentle, bouncy }Transitionవేగవంతమైన, దృఢమైనవి నుండి మృదువైన, ఎగిరేవి వరకు spring ట్రాన్సిషన్‌లు.
ట్రాన్సిషన్‌లు
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} />
    </>
  );
}

వెతకండి

డాక్యుమెంటేషన్‌లో వెతకడానికి టైప్ చేయండి.