metadata.json 132 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667
  1. {
  2. "name": "@shoelace-style/shoelace",
  3. "description": "A forward-thinking library of web components.",
  4. "version": "2.0.0-beta.43",
  5. "author": "Cory LaViska",
  6. "homepage": "https://github.com/shoelace-style/shoelace",
  7. "license": "MIT",
  8. "components": [
  9. {
  10. "className": "SlAlert",
  11. "tag": "sl-alert",
  12. "file": "src/components/alert/alert.ts",
  13. "since": "2.0",
  14. "status": "stable",
  15. "props": [
  16. {
  17. "name": "closable",
  18. "description": "Makes the alert closable.",
  19. "type": "boolean",
  20. "defaultValue": "false"
  21. },
  22. {
  23. "name": "duration",
  24. "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`.",
  25. "type": "number",
  26. "defaultValue": "..."
  27. },
  28. {
  29. "name": "open",
  30. "description": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods.",
  31. "type": "boolean",
  32. "defaultValue": "false"
  33. },
  34. {
  35. "name": "type",
  36. "description": "The type of alert.",
  37. "type": "'primary' | 'success' | 'info' | 'warning' | 'danger'",
  38. "values": [
  39. "primary",
  40. "success",
  41. "info",
  42. "warning",
  43. "danger"
  44. ],
  45. "defaultValue": "'primary'"
  46. }
  47. ],
  48. "methods": [
  49. {
  50. "name": "hide",
  51. "description": "Hides the alert",
  52. "params": []
  53. },
  54. {
  55. "name": "show",
  56. "description": "Shows the alert.",
  57. "params": []
  58. },
  59. {
  60. "name": "toast",
  61. "description": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.",
  62. "params": []
  63. }
  64. ],
  65. "events": [
  66. {
  67. "name": "sl-after-hide",
  68. "description": "Emitted after the alert closes and all transitions are complete.",
  69. "details": "void"
  70. },
  71. {
  72. "name": "sl-after-show",
  73. "description": "Emitted after the alert opens and all transitions are complete.",
  74. "details": "void"
  75. },
  76. {
  77. "name": "sl-hide",
  78. "description": "Emitted when the alert closes.",
  79. "details": "void"
  80. },
  81. {
  82. "name": "sl-show",
  83. "description": "Emitted when the alert opens.",
  84. "details": "void"
  85. }
  86. ],
  87. "slots": [
  88. {
  89. "name": "",
  90. "description": "The alert's content."
  91. },
  92. {
  93. "name": "icon",
  94. "description": "An icon to show in the alert.\n"
  95. }
  96. ],
  97. "cssCustomProperties": [
  98. {
  99. "name": "--box-shadow",
  100. "description": "The alert's box shadow.\n"
  101. }
  102. ],
  103. "parts": [
  104. {
  105. "name": "base",
  106. "description": "The component's base wrapper."
  107. },
  108. {
  109. "name": "icon",
  110. "description": "The container that wraps the alert icon."
  111. },
  112. {
  113. "name": "message",
  114. "description": "The alert message."
  115. },
  116. {
  117. "name": "close-button",
  118. "description": "The close button.\n"
  119. }
  120. ],
  121. "dependencies": [
  122. "sl-icon-button"
  123. ],
  124. "animations": [
  125. {
  126. "name": "alert.show",
  127. "description": "The animation to use when showing the alert."
  128. },
  129. {
  130. "name": "alert.hide",
  131. "description": "The animation to use when hiding the alert.\n"
  132. }
  133. ]
  134. },
  135. {
  136. "className": "SlAnimation",
  137. "tag": "sl-animation",
  138. "file": "src/components/animation/animation.ts",
  139. "since": "2.0",
  140. "status": "stable",
  141. "props": [
  142. {
  143. "name": "delay",
  144. "description": "The number of milliseconds to delay the start of the animation.",
  145. "type": "number",
  146. "defaultValue": "0"
  147. },
  148. {
  149. "name": "direction",
  150. "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.",
  151. "type": "PlaybackDirection",
  152. "defaultValue": "'normal'"
  153. },
  154. {
  155. "name": "duration",
  156. "description": "The number of milliseconds each iteration of the animation takes to complete.",
  157. "type": "number",
  158. "defaultValue": "1000"
  159. },
  160. {
  161. "name": "easing",
  162. "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
  163. "type": "string",
  164. "defaultValue": "'linear'"
  165. },
  166. {
  167. "name": "endDelay",
  168. "attribute": "end-delay",
  169. "description": "The number of milliseconds to delay after the active period of an animation sequence.",
  170. "type": "number",
  171. "defaultValue": "0"
  172. },
  173. {
  174. "name": "fill",
  175. "description": "Sets how the animation applies styles to its target before and after its execution.",
  176. "type": "FillMode",
  177. "defaultValue": "'auto'"
  178. },
  179. {
  180. "name": "iterationStart",
  181. "attribute": "iteration-start",
  182. "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
  183. "type": "number",
  184. "defaultValue": "0"
  185. },
  186. {
  187. "name": "iterations",
  188. "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
  189. "type": "number",
  190. "defaultValue": "..."
  191. },
  192. {
  193. "name": "keyframes",
  194. "description": "The keyframes to use for the animation. If this is set, `name` will be ignored.",
  195. "type": ""
  196. },
  197. {
  198. "name": "name",
  199. "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.",
  200. "type": "string",
  201. "defaultValue": "'none'"
  202. },
  203. {
  204. "name": "pause",
  205. "description": "Pauses the animation. The animation will resume when this prop is removed.",
  206. "type": "boolean",
  207. "defaultValue": "false"
  208. },
  209. {
  210. "name": "playbackRate",
  211. "attribute": "playback-rate",
  212. "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.",
  213. "type": "number",
  214. "defaultValue": "1"
  215. }
  216. ],
  217. "methods": [
  218. {
  219. "name": "cancel",
  220. "description": "Clears all KeyframeEffects caused by this animation and aborts its playback.",
  221. "params": []
  222. },
  223. {
  224. "name": "finish",
  225. "description": "Sets the playback time to the end of the animation corresponding to the current playback direction.",
  226. "params": []
  227. },
  228. {
  229. "name": "getCurrentTime",
  230. "description": "Gets the current time of the animation in milliseconds.",
  231. "params": []
  232. },
  233. {
  234. "name": "setCurrentTime",
  235. "description": "Sets the current time of the animation in milliseconds.",
  236. "params": [
  237. {
  238. "name": "time",
  239. "type": "number"
  240. }
  241. ]
  242. }
  243. ],
  244. "events": [
  245. {
  246. "name": "sl-cancel",
  247. "description": "Emitted when the animation is canceled.",
  248. "details": "void"
  249. },
  250. {
  251. "name": "sl-finish",
  252. "description": "Emitted when the animation finishes.",
  253. "details": "void"
  254. },
  255. {
  256. "name": "sl-start",
  257. "description": "Emitted when the animation starts or restarts.",
  258. "details": "void"
  259. }
  260. ],
  261. "slots": [
  262. {
  263. "name": "",
  264. "description": "The element to animate. If multiple elements are to be animated, wrap them in a single container."
  265. }
  266. ],
  267. "cssCustomProperties": [],
  268. "parts": [],
  269. "dependencies": [],
  270. "animations": []
  271. },
  272. {
  273. "className": "SlAvatar",
  274. "tag": "sl-avatar",
  275. "file": "src/components/avatar/avatar.ts",
  276. "since": "2.0",
  277. "status": "stable",
  278. "props": [
  279. {
  280. "name": "alt",
  281. "description": "Alternative text for the image.",
  282. "type": "string"
  283. },
  284. {
  285. "name": "image",
  286. "description": "The image source to use for the avatar.",
  287. "type": "string"
  288. },
  289. {
  290. "name": "initials",
  291. "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
  292. "type": "string"
  293. },
  294. {
  295. "name": "shape",
  296. "description": "The shape of the avatar.",
  297. "type": "'circle' | 'square' | 'rounded'",
  298. "values": [
  299. "circle",
  300. "square",
  301. "rounded"
  302. ],
  303. "defaultValue": "'circle'"
  304. }
  305. ],
  306. "methods": [],
  307. "events": [],
  308. "slots": [
  309. {
  310. "name": "icon",
  311. "description": "The default icon to use when no image or initials are present.\n"
  312. }
  313. ],
  314. "cssCustomProperties": [
  315. {
  316. "name": "--size",
  317. "description": "The size of the avatar.\n"
  318. }
  319. ],
  320. "parts": [
  321. {
  322. "name": "base",
  323. "description": "The component's base wrapper."
  324. },
  325. {
  326. "name": "icon",
  327. "description": "The container that wraps the avatar icon."
  328. },
  329. {
  330. "name": "initials",
  331. "description": "The container that wraps the avatar initials."
  332. },
  333. {
  334. "name": "image",
  335. "description": "The avatar image.\n"
  336. }
  337. ],
  338. "dependencies": [
  339. "sl-icon"
  340. ],
  341. "animations": []
  342. },
  343. {
  344. "className": "SlBadge",
  345. "tag": "sl-badge",
  346. "file": "src/components/badge/badge.ts",
  347. "since": "2.0",
  348. "status": "stable",
  349. "props": [
  350. {
  351. "name": "pill",
  352. "description": "Draws a pill-style badge with rounded edges.",
  353. "type": "boolean",
  354. "defaultValue": "false"
  355. },
  356. {
  357. "name": "pulse",
  358. "description": "Makes the badge pulsate to draw attention.",
  359. "type": "boolean",
  360. "defaultValue": "false"
  361. },
  362. {
  363. "name": "type",
  364. "description": "The badge's type.",
  365. "type": "'primary' | 'success' | 'info' | 'warning' | 'danger'",
  366. "values": [
  367. "primary",
  368. "success",
  369. "info",
  370. "warning",
  371. "danger"
  372. ],
  373. "defaultValue": "'primary'"
  374. }
  375. ],
  376. "methods": [],
  377. "events": [],
  378. "slots": [
  379. {
  380. "name": "",
  381. "description": "The badge's content."
  382. }
  383. ],
  384. "cssCustomProperties": [],
  385. "parts": [
  386. {
  387. "name": "base",
  388. "description": "The base wrapper\n"
  389. }
  390. ],
  391. "dependencies": [],
  392. "animations": []
  393. },
  394. {
  395. "className": "SlButton",
  396. "tag": "sl-button",
  397. "file": "src/components/button/button.ts",
  398. "since": "2.0",
  399. "status": "stable",
  400. "props": [
  401. {
  402. "name": "caret",
  403. "description": "Draws the button with a caret for use with dropdowns, popovers, etc.",
  404. "type": "boolean",
  405. "defaultValue": "false"
  406. },
  407. {
  408. "name": "circle",
  409. "description": "Draws a circle button.",
  410. "type": "boolean",
  411. "defaultValue": "false"
  412. },
  413. {
  414. "name": "disabled",
  415. "description": "Disables the button.",
  416. "type": "boolean",
  417. "defaultValue": "false"
  418. },
  419. {
  420. "name": "download",
  421. "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
  422. "type": "string"
  423. },
  424. {
  425. "name": "href",
  426. "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
  427. "type": "string"
  428. },
  429. {
  430. "name": "loading",
  431. "description": "Draws the button in a loading state.",
  432. "type": "boolean",
  433. "defaultValue": "false"
  434. },
  435. {
  436. "name": "name",
  437. "description": "An optional name for the button. Ignored when `href` is set.",
  438. "type": "string"
  439. },
  440. {
  441. "name": "pill",
  442. "description": "Draws a pill-style button with rounded edges.",
  443. "type": "boolean",
  444. "defaultValue": "false"
  445. },
  446. {
  447. "name": "size",
  448. "description": "The button's size.",
  449. "type": "'small' | 'medium' | 'large'",
  450. "values": [
  451. "small",
  452. "medium",
  453. "large"
  454. ],
  455. "defaultValue": "'medium'"
  456. },
  457. {
  458. "name": "submit",
  459. "description": "Indicates if activating the button should submit the form. Ignored when `href` is set.",
  460. "type": "boolean",
  461. "defaultValue": "false"
  462. },
  463. {
  464. "name": "target",
  465. "description": "Tells the browser where to open the link. Only used when `href` is set.",
  466. "type": "'_blank' | '_parent' | '_self' | '_top'",
  467. "values": [
  468. "_blank",
  469. "_parent",
  470. "_self",
  471. "_top"
  472. ]
  473. },
  474. {
  475. "name": "type",
  476. "description": "The button's type.",
  477. "type": "'primary' | 'success' | 'info' | 'warning' | 'danger' | 'default' | 'text'",
  478. "values": [
  479. "primary",
  480. "success",
  481. "info",
  482. "warning",
  483. "danger",
  484. "default",
  485. "text"
  486. ],
  487. "defaultValue": "'default'"
  488. },
  489. {
  490. "name": "value",
  491. "description": "An optional value for the button. Ignored when `href` is set.",
  492. "type": "string"
  493. }
  494. ],
  495. "methods": [
  496. {
  497. "name": "blur",
  498. "description": "Removes focus from the button.",
  499. "params": []
  500. },
  501. {
  502. "name": "click",
  503. "description": "Simulates a click on the button.",
  504. "params": []
  505. },
  506. {
  507. "name": "focus",
  508. "description": "Sets focus on the button.",
  509. "params": [
  510. {
  511. "name": "options",
  512. "type": "FocusOptions",
  513. "isOptional": true
  514. }
  515. ]
  516. }
  517. ],
  518. "events": [
  519. {
  520. "name": "sl-blur",
  521. "description": "Emitted when the button loses focus.",
  522. "details": "void"
  523. },
  524. {
  525. "name": "sl-focus",
  526. "description": "Emitted when the button gains focus.",
  527. "details": "void"
  528. }
  529. ],
  530. "slots": [
  531. {
  532. "name": "",
  533. "description": "The button's label."
  534. },
  535. {
  536. "name": "prefix",
  537. "description": "Used to prepend an icon or similar element to the button."
  538. },
  539. {
  540. "name": "suffix",
  541. "description": "Used to append an icon or similar element to the button.\n"
  542. }
  543. ],
  544. "cssCustomProperties": [],
  545. "parts": [
  546. {
  547. "name": "base",
  548. "description": "The component's base wrapper."
  549. },
  550. {
  551. "name": "prefix",
  552. "description": "The prefix container."
  553. },
  554. {
  555. "name": "label",
  556. "description": "The button's label."
  557. },
  558. {
  559. "name": "suffix",
  560. "description": "The suffix container."
  561. },
  562. {
  563. "name": "caret",
  564. "description": "The button's caret.\n"
  565. }
  566. ],
  567. "dependencies": [
  568. "sl-spinner"
  569. ],
  570. "animations": []
  571. },
  572. {
  573. "className": "SlButtonGroup",
  574. "tag": "sl-button-group",
  575. "file": "src/components/button-group/button-group.ts",
  576. "since": "2.0",
  577. "status": "stable",
  578. "props": [
  579. {
  580. "name": "label",
  581. "description": "A label to use for the button group's `aria-label` attribute.",
  582. "type": "string",
  583. "defaultValue": "''"
  584. }
  585. ],
  586. "methods": [],
  587. "events": [],
  588. "slots": [
  589. {
  590. "name": "",
  591. "description": "One or more `<sl-button>` elements to display in the button group."
  592. }
  593. ],
  594. "cssCustomProperties": [],
  595. "parts": [
  596. {
  597. "name": "base",
  598. "description": "The component's base wrapper.\n"
  599. }
  600. ],
  601. "dependencies": [],
  602. "animations": []
  603. },
  604. {
  605. "className": "SlCard",
  606. "tag": "sl-card",
  607. "file": "src/components/card/card.ts",
  608. "since": "2.0",
  609. "status": "stable",
  610. "props": [],
  611. "methods": [],
  612. "events": [],
  613. "slots": [
  614. {
  615. "name": "",
  616. "description": "The card's body."
  617. },
  618. {
  619. "name": "header",
  620. "description": "The card's header."
  621. },
  622. {
  623. "name": "footer",
  624. "description": "The card's footer."
  625. },
  626. {
  627. "name": "image",
  628. "description": "The card's image.\n"
  629. }
  630. ],
  631. "cssCustomProperties": [
  632. {
  633. "name": "--border-color",
  634. "description": "The card's border color, including borders that occur inside the card."
  635. },
  636. {
  637. "name": "--border-radius",
  638. "description": "The border radius for card edges."
  639. },
  640. {
  641. "name": "--border-width",
  642. "description": "The width of card borders."
  643. },
  644. {
  645. "name": "--padding",
  646. "description": "The padding to use for card sections.*\n"
  647. }
  648. ],
  649. "parts": [
  650. {
  651. "name": "base",
  652. "description": "The component's base wrapper."
  653. },
  654. {
  655. "name": "image",
  656. "description": "The card's image, if present."
  657. },
  658. {
  659. "name": "header",
  660. "description": "The card's header, if present."
  661. },
  662. {
  663. "name": "body",
  664. "description": "The card's body."
  665. },
  666. {
  667. "name": "footer",
  668. "description": "The card's footer, if present.\n"
  669. }
  670. ],
  671. "dependencies": [],
  672. "animations": []
  673. },
  674. {
  675. "className": "SlCheckbox",
  676. "tag": "sl-checkbox",
  677. "file": "src/components/checkbox/checkbox.ts",
  678. "since": "2.0",
  679. "status": "stable",
  680. "props": [
  681. {
  682. "name": "checked",
  683. "description": "Draws the checkbox in a checked state.",
  684. "type": "boolean",
  685. "defaultValue": "false"
  686. },
  687. {
  688. "name": "disabled",
  689. "description": "Disables the checkbox.",
  690. "type": "boolean",
  691. "defaultValue": "false"
  692. },
  693. {
  694. "name": "indeterminate",
  695. "description": "Draws the checkbox in an indeterminate state.",
  696. "type": "boolean",
  697. "defaultValue": "false"
  698. },
  699. {
  700. "name": "invalid",
  701. "description": "This will be true when the control is in an invalid state. Validity is determined by the `required` prop.",
  702. "type": "boolean",
  703. "defaultValue": "false"
  704. },
  705. {
  706. "name": "name",
  707. "description": "The checkbox's name attribute.",
  708. "type": "string"
  709. },
  710. {
  711. "name": "required",
  712. "description": "Makes the checkbox a required field.",
  713. "type": "boolean",
  714. "defaultValue": "false"
  715. },
  716. {
  717. "name": "value",
  718. "description": "The checkbox's value attribute.",
  719. "type": "string"
  720. }
  721. ],
  722. "methods": [
  723. {
  724. "name": "blur",
  725. "description": "Removes focus from the checkbox.",
  726. "params": []
  727. },
  728. {
  729. "name": "click",
  730. "description": "Simulates a click on the checkbox.",
  731. "params": []
  732. },
  733. {
  734. "name": "focus",
  735. "description": "Sets focus on the checkbox.",
  736. "params": [
  737. {
  738. "name": "options",
  739. "type": "FocusOptions",
  740. "isOptional": true
  741. }
  742. ]
  743. },
  744. {
  745. "name": "reportValidity",
  746. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  747. "params": []
  748. },
  749. {
  750. "name": "setCustomValidity",
  751. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  752. "params": [
  753. {
  754. "name": "message",
  755. "type": "string"
  756. }
  757. ]
  758. }
  759. ],
  760. "events": [
  761. {
  762. "name": "sl-blur",
  763. "description": "Emitted when the control loses focus.",
  764. "details": "void"
  765. },
  766. {
  767. "name": "sl-change",
  768. "description": "Emitted when the control's checked state changes.",
  769. "details": "void"
  770. },
  771. {
  772. "name": "sl-focus",
  773. "description": "Emitted when the control gains focus.",
  774. "details": "void"
  775. }
  776. ],
  777. "slots": [
  778. {
  779. "name": "",
  780. "description": "The checkbox's label."
  781. }
  782. ],
  783. "cssCustomProperties": [],
  784. "parts": [
  785. {
  786. "name": "base",
  787. "description": "The component's base wrapper."
  788. },
  789. {
  790. "name": "control",
  791. "description": "The checkbox control."
  792. },
  793. {
  794. "name": "checked-icon",
  795. "description": "The container the wraps the checked icon."
  796. },
  797. {
  798. "name": "indeterminate-icon",
  799. "description": "The container that wraps the indeterminate icon."
  800. },
  801. {
  802. "name": "label",
  803. "description": "The checkbox label.\n"
  804. }
  805. ],
  806. "dependencies": [],
  807. "animations": []
  808. },
  809. {
  810. "className": "SlColorPicker",
  811. "tag": "sl-color-picker",
  812. "file": "src/components/color-picker/color-picker.ts",
  813. "since": "2.0",
  814. "status": "stable",
  815. "props": [
  816. {
  817. "name": "disabled",
  818. "description": "Disables the color picker.",
  819. "type": "boolean",
  820. "defaultValue": "false"
  821. },
  822. {
  823. "name": "format",
  824. "description": "The format to use for the display value. If opacity is enabled, these will translate to HEXA, RGBA, and HSLA\nrespectively. The color picker will always accept user input in any format (including CSS color names) and convert\nit to the desired format.",
  825. "type": "'hex' | 'rgb' | 'hsl'",
  826. "values": [
  827. "hex",
  828. "rgb",
  829. "hsl"
  830. ],
  831. "defaultValue": "'hex'"
  832. },
  833. {
  834. "name": "hoist",
  835. "description": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`.",
  836. "type": "boolean",
  837. "defaultValue": "false"
  838. },
  839. {
  840. "name": "inline",
  841. "description": "Renders the color picker inline rather than inside a dropdown.",
  842. "type": "boolean",
  843. "defaultValue": "false"
  844. },
  845. {
  846. "name": "invalid",
  847. "description": "This will be true when the control is in an invalid state. Validity is determined by the `setCustomValidity()`\nmethod using the browser's constraint validation API.",
  848. "type": "boolean",
  849. "defaultValue": "false"
  850. },
  851. {
  852. "name": "name",
  853. "description": "The input's name attribute.",
  854. "type": "string",
  855. "defaultValue": "''"
  856. },
  857. {
  858. "name": "noFormatToggle",
  859. "attribute": "no-format-toggle",
  860. "description": "Removes the format toggle.",
  861. "type": "boolean",
  862. "defaultValue": "false"
  863. },
  864. {
  865. "name": "opacity",
  866. "description": "Whether to show the opacity slider.",
  867. "type": "boolean",
  868. "defaultValue": "false"
  869. },
  870. {
  871. "name": "size",
  872. "description": "Determines the size of the color picker's trigger. This has no effect on inline color pickers.",
  873. "type": "'small' | 'medium' | 'large'",
  874. "values": [
  875. "small",
  876. "medium",
  877. "large"
  878. ],
  879. "defaultValue": "'medium'"
  880. },
  881. {
  882. "name": "swatches",
  883. "description": "An array of predefined color swatches to display. Can include any format the color picker can parse, including\nHEX(A), RGB(A), HSL(A), and CSS color names.",
  884. "type": "",
  885. "defaultValue": "..."
  886. },
  887. {
  888. "name": "uppercase",
  889. "description": "By default, the value will be set in lowercase. Set this to true to set it in uppercase instead.",
  890. "type": "boolean",
  891. "defaultValue": "false"
  892. },
  893. {
  894. "name": "value",
  895. "description": "The current color.",
  896. "type": "string",
  897. "defaultValue": "'#ffffff'"
  898. }
  899. ],
  900. "methods": [
  901. {
  902. "name": "getFormattedValue",
  903. "description": "Returns the current value as a string in the specified format.",
  904. "params": [
  905. {
  906. "name": "format",
  907. "type": "'hex' | 'rgb' | 'hsl' | 'hexa' | 'rgba' | 'hsla'",
  908. "values": [
  909. "hex",
  910. "rgb",
  911. "hsl",
  912. "hexa",
  913. "rgba",
  914. "hsla"
  915. ],
  916. "defaultValue": "'hex'"
  917. }
  918. ]
  919. },
  920. {
  921. "name": "reportValidity",
  922. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  923. "params": []
  924. },
  925. {
  926. "name": "setCustomValidity",
  927. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  928. "params": [
  929. {
  930. "name": "message",
  931. "type": "string"
  932. }
  933. ]
  934. }
  935. ],
  936. "events": [
  937. {
  938. "name": "sl-change",
  939. "description": "Emitted when the color picker's value changes.",
  940. "details": "void"
  941. }
  942. ],
  943. "slots": [],
  944. "cssCustomProperties": [
  945. {
  946. "name": "--grid-width",
  947. "description": "The width of the color grid."
  948. },
  949. {
  950. "name": "--grid-height",
  951. "description": "The height of the color grid."
  952. },
  953. {
  954. "name": "--grid-handle-size",
  955. "description": "The size of the color grid's handle."
  956. },
  957. {
  958. "name": "--slider-height",
  959. "description": "The height of the hue and alpha sliders."
  960. },
  961. {
  962. "name": "--slider-handle-size",
  963. "description": "The diameter of the slider's handle.\n"
  964. }
  965. ],
  966. "parts": [
  967. {
  968. "name": "base",
  969. "description": "The component's base wrapper."
  970. },
  971. {
  972. "name": "trigger",
  973. "description": "The color picker's dropdown trigger."
  974. },
  975. {
  976. "name": "swatches",
  977. "description": "The container that holds swatches."
  978. },
  979. {
  980. "name": "swatch",
  981. "description": "Each individual swatch."
  982. },
  983. {
  984. "name": "grid",
  985. "description": "The color grid."
  986. },
  987. {
  988. "name": "grid-handle",
  989. "description": "The color grid's handle."
  990. },
  991. {
  992. "name": "hue-slider",
  993. "description": "The hue slider."
  994. },
  995. {
  996. "name": "opacity-slider",
  997. "description": "The opacity slider."
  998. },
  999. {
  1000. "name": "slider",
  1001. "description": "Hue and opacity sliders."
  1002. },
  1003. {
  1004. "name": "slider-handle",
  1005. "description": "Hue and opacity slider handles."
  1006. },
  1007. {
  1008. "name": "preview",
  1009. "description": "The preview color."
  1010. },
  1011. {
  1012. "name": "input",
  1013. "description": "The text input."
  1014. },
  1015. {
  1016. "name": "format-button",
  1017. "description": "The toggle format button's base.\n"
  1018. }
  1019. ],
  1020. "dependencies": [
  1021. "sl-button",
  1022. "sl-dropdown",
  1023. "sl-icon",
  1024. "sl-input"
  1025. ],
  1026. "animations": []
  1027. },
  1028. {
  1029. "className": "SlDetails",
  1030. "tag": "sl-details",
  1031. "file": "src/components/details/details.ts",
  1032. "since": "2.0",
  1033. "status": "stable",
  1034. "props": [
  1035. {
  1036. "name": "disabled",
  1037. "description": "Disables the details so it can't be toggled.",
  1038. "type": "boolean",
  1039. "defaultValue": "false"
  1040. },
  1041. {
  1042. "name": "open",
  1043. "description": "Indicates whether or not the details is open. You can use this in lieu of the show/hide methods.",
  1044. "type": "boolean",
  1045. "defaultValue": "false"
  1046. },
  1047. {
  1048. "name": "summary",
  1049. "description": "The summary to show in the details header. If you need to display HTML, use the `summary` slot instead.",
  1050. "type": "string"
  1051. }
  1052. ],
  1053. "methods": [
  1054. {
  1055. "name": "hide",
  1056. "description": "Hides the details",
  1057. "params": []
  1058. },
  1059. {
  1060. "name": "show",
  1061. "description": "Shows the details.",
  1062. "params": []
  1063. }
  1064. ],
  1065. "events": [
  1066. {
  1067. "name": "sl-after-hide",
  1068. "description": "Emitted after the details closes and all transitions are complete.",
  1069. "details": "void"
  1070. },
  1071. {
  1072. "name": "sl-after-show",
  1073. "description": "Emitted after the details opens and all transitions are complete.",
  1074. "details": "void"
  1075. },
  1076. {
  1077. "name": "sl-hide",
  1078. "description": "Emitted when the details closes.",
  1079. "details": "void"
  1080. },
  1081. {
  1082. "name": "sl-show",
  1083. "description": "Emitted when the details opens.",
  1084. "details": "void"
  1085. }
  1086. ],
  1087. "slots": [
  1088. {
  1089. "name": "",
  1090. "description": "The details' content."
  1091. },
  1092. {
  1093. "name": "summary",
  1094. "description": "The details' summary. Alternatively, you can use the summary prop.\n"
  1095. }
  1096. ],
  1097. "cssCustomProperties": [],
  1098. "parts": [
  1099. {
  1100. "name": "base",
  1101. "description": "The component's base wrapper."
  1102. },
  1103. {
  1104. "name": "header",
  1105. "description": "The summary header."
  1106. },
  1107. {
  1108. "name": "summary",
  1109. "description": "The details summary."
  1110. },
  1111. {
  1112. "name": "summary-icon",
  1113. "description": "The expand/collapse summary icon."
  1114. },
  1115. {
  1116. "name": "content",
  1117. "description": "The details content.\n"
  1118. }
  1119. ],
  1120. "dependencies": [
  1121. "sl-icon"
  1122. ],
  1123. "animations": [
  1124. {
  1125. "name": "details.show",
  1126. "description": "The animation to use when showing details. You can use `height: auto` with this animation."
  1127. },
  1128. {
  1129. "name": "details.hide",
  1130. "description": "The animation to use when hiding details. You can use `height: auto` with this animation.\n"
  1131. }
  1132. ]
  1133. },
  1134. {
  1135. "className": "SlDialog",
  1136. "tag": "sl-dialog",
  1137. "file": "src/components/dialog/dialog.ts",
  1138. "since": "2.0",
  1139. "status": "stable",
  1140. "props": [
  1141. {
  1142. "name": "label",
  1143. "description": "The dialog's label as displayed in the header. You should always include a relevant label even when using\n`no-header`, as it is required for proper accessibility.",
  1144. "type": "string",
  1145. "defaultValue": "''"
  1146. },
  1147. {
  1148. "name": "noHeader",
  1149. "attribute": "no-header",
  1150. "description": "Disables the header. This will also remove the default close button, so please ensure you provide an easy,\naccessible way for users to dismiss the dialog.",
  1151. "type": "boolean",
  1152. "defaultValue": "false"
  1153. },
  1154. {
  1155. "name": "open",
  1156. "description": "Indicates whether or not the dialog is open. You can use this in lieu of the show/hide methods.",
  1157. "type": "boolean",
  1158. "defaultValue": "false"
  1159. }
  1160. ],
  1161. "methods": [
  1162. {
  1163. "name": "hide",
  1164. "description": "Hides the dialog",
  1165. "params": []
  1166. },
  1167. {
  1168. "name": "show",
  1169. "description": "Shows the dialog.",
  1170. "params": []
  1171. }
  1172. ],
  1173. "events": [
  1174. {
  1175. "name": "sl-after-hide",
  1176. "description": "Emitted after the dialog closes and all transitions are complete.",
  1177. "details": "void"
  1178. },
  1179. {
  1180. "name": "sl-after-show",
  1181. "description": "Emitted after the dialog opens and all transitions are complete.",
  1182. "details": "void"
  1183. },
  1184. {
  1185. "name": "sl-hide",
  1186. "description": "Emitted when the dialog closes.",
  1187. "details": "void"
  1188. },
  1189. {
  1190. "name": "sl-initial-focus",
  1191. "description": "Emitted when the dialog opens and the panel gains focus. Calling `event.preventDefault()` will prevent focus and\nallow you to set it on a different element in the dialog, such as an input or button.",
  1192. "details": "void"
  1193. },
  1194. {
  1195. "name": "sl-overlay-dismiss",
  1196. "description": "Emitted when the overlay is clicked. Calling `event.preventDefault()` will prevent the dialog from closing.",
  1197. "details": "void"
  1198. },
  1199. {
  1200. "name": "sl-show",
  1201. "description": "Emitted when the dialog opens.",
  1202. "details": "void"
  1203. }
  1204. ],
  1205. "slots": [
  1206. {
  1207. "name": "",
  1208. "description": "The dialog's content."
  1209. },
  1210. {
  1211. "name": "label",
  1212. "description": "The dialog's label. Alternatively, you can use the label prop."
  1213. },
  1214. {
  1215. "name": "footer",
  1216. "description": "The dialog's footer, usually one or more buttons representing various options.\n"
  1217. }
  1218. ],
  1219. "cssCustomProperties": [
  1220. {
  1221. "name": "--width",
  1222. "description": "The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens."
  1223. },
  1224. {
  1225. "name": "--header-spacing",
  1226. "description": "The amount of padding to use for the header."
  1227. },
  1228. {
  1229. "name": "--body-spacing",
  1230. "description": "The amount of padding to use for the body."
  1231. },
  1232. {
  1233. "name": "--footer-spacing",
  1234. "description": "The amount of padding to use for the footer.\n"
  1235. }
  1236. ],
  1237. "parts": [
  1238. {
  1239. "name": "base",
  1240. "description": "The component's base wrapper."
  1241. },
  1242. {
  1243. "name": "overlay",
  1244. "description": "The overlay."
  1245. },
  1246. {
  1247. "name": "panel",
  1248. "description": "The dialog panel (where the dialog and its content is rendered)."
  1249. },
  1250. {
  1251. "name": "header",
  1252. "description": "The dialog header."
  1253. },
  1254. {
  1255. "name": "title",
  1256. "description": "The dialog title."
  1257. },
  1258. {
  1259. "name": "close-button",
  1260. "description": "The close button."
  1261. },
  1262. {
  1263. "name": "body",
  1264. "description": "The dialog body."
  1265. },
  1266. {
  1267. "name": "footer",
  1268. "description": "The dialog footer.\n"
  1269. }
  1270. ],
  1271. "dependencies": [
  1272. "sl-icon-button"
  1273. ],
  1274. "animations": [
  1275. {
  1276. "name": "dialog.show",
  1277. "description": "The animation to use when showing the dialog."
  1278. },
  1279. {
  1280. "name": "dialog.hide",
  1281. "description": "The animation to use when hiding the dialog."
  1282. },
  1283. {
  1284. "name": "dialog.overlay.show",
  1285. "description": "The animation to use when showing the dialog's overlay."
  1286. },
  1287. {
  1288. "name": "dialog.overlay.hide",
  1289. "description": "The animation to use when hiding the dialog's overlay.\n"
  1290. }
  1291. ]
  1292. },
  1293. {
  1294. "className": "SlDrawer",
  1295. "tag": "sl-drawer",
  1296. "file": "src/components/drawer/drawer.ts",
  1297. "since": "2.0",
  1298. "status": "stable",
  1299. "props": [
  1300. {
  1301. "name": "contained",
  1302. "description": "By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of\nits parent element, set this prop and add `position: relative` to the parent.",
  1303. "type": "boolean",
  1304. "defaultValue": "false"
  1305. },
  1306. {
  1307. "name": "label",
  1308. "description": "The drawer's label as displayed in the header. You should always include a relevant label even when using\n`no-header`, as it is required for proper accessibility.",
  1309. "type": "string",
  1310. "defaultValue": "''"
  1311. },
  1312. {
  1313. "name": "noHeader",
  1314. "attribute": "no-header",
  1315. "description": "Removes the header. This will also remove the default close button, so please ensure you provide an easy,\naccessible way for users to dismiss the drawer.",
  1316. "type": "boolean",
  1317. "defaultValue": "false"
  1318. },
  1319. {
  1320. "name": "open",
  1321. "description": "Indicates whether or not the drawer is open. You can use this in lieu of the show/hide methods.",
  1322. "type": "boolean",
  1323. "defaultValue": "false"
  1324. },
  1325. {
  1326. "name": "placement",
  1327. "description": "The direction from which the drawer will open.",
  1328. "type": "'top' | 'end' | 'bottom' | 'start'",
  1329. "values": [
  1330. "top",
  1331. "end",
  1332. "bottom",
  1333. "start"
  1334. ],
  1335. "defaultValue": "'end'"
  1336. }
  1337. ],
  1338. "methods": [
  1339. {
  1340. "name": "hide",
  1341. "description": "Hides the drawer",
  1342. "params": []
  1343. },
  1344. {
  1345. "name": "show",
  1346. "description": "Shows the drawer.",
  1347. "params": []
  1348. }
  1349. ],
  1350. "events": [
  1351. {
  1352. "name": "sl-after-hide",
  1353. "description": "Emitted after the drawer closes and all transitions are complete.",
  1354. "details": "void"
  1355. },
  1356. {
  1357. "name": "sl-after-show",
  1358. "description": "Emitted after the drawer opens and all transitions are complete.",
  1359. "details": "void"
  1360. },
  1361. {
  1362. "name": "sl-hide",
  1363. "description": "Emitted when the drawer closes.",
  1364. "details": "void"
  1365. },
  1366. {
  1367. "name": "sl-initial-focus",
  1368. "description": "Emitted when the drawer opens and the panel gains focus. Calling `event.preventDefault()` will prevent focus and allow you to set it on a different element in the drawer, such as an input or button.",
  1369. "details": "void"
  1370. },
  1371. {
  1372. "name": "sl-overlay-dismiss",
  1373. "description": "Emitted when the overlay is clicked. Calling `event.preventDefault()` will prevent the drawer from closing.",
  1374. "details": "void"
  1375. },
  1376. {
  1377. "name": "sl-show",
  1378. "description": "Emitted when the drawer opens.",
  1379. "details": "void"
  1380. }
  1381. ],
  1382. "slots": [
  1383. {
  1384. "name": "",
  1385. "description": "The drawer's content."
  1386. },
  1387. {
  1388. "name": "label",
  1389. "description": "The drawer's label. Alternatively, you can use the label prop."
  1390. },
  1391. {
  1392. "name": "footer",
  1393. "description": "The drawer's footer, usually one or more buttons representing various options.\n"
  1394. }
  1395. ],
  1396. "cssCustomProperties": [
  1397. {
  1398. "name": "--size",
  1399. "description": "The preferred size of the drawer. This will be applied to the drawer's width or height\n depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens."
  1400. },
  1401. {
  1402. "name": "--header-spacing",
  1403. "description": "The amount of padding to use for the header."
  1404. },
  1405. {
  1406. "name": "--body-spacing",
  1407. "description": "The amount of padding to use for the body."
  1408. },
  1409. {
  1410. "name": "--footer-spacing",
  1411. "description": "The amount of padding to use for the footer.\n"
  1412. }
  1413. ],
  1414. "parts": [
  1415. {
  1416. "name": "base",
  1417. "description": "The component's base wrapper."
  1418. },
  1419. {
  1420. "name": "overlay",
  1421. "description": "The overlay."
  1422. },
  1423. {
  1424. "name": "panel",
  1425. "description": "The drawer panel (where the drawer and its content is rendered)."
  1426. },
  1427. {
  1428. "name": "header",
  1429. "description": "The drawer header."
  1430. },
  1431. {
  1432. "name": "title",
  1433. "description": "The drawer title."
  1434. },
  1435. {
  1436. "name": "close-button",
  1437. "description": "The close button."
  1438. },
  1439. {
  1440. "name": "body",
  1441. "description": "The drawer body."
  1442. },
  1443. {
  1444. "name": "footer",
  1445. "description": "The drawer footer.\n"
  1446. }
  1447. ],
  1448. "dependencies": [
  1449. "sl-icon-button"
  1450. ],
  1451. "animations": [
  1452. {
  1453. "name": "drawer.showTop",
  1454. "description": "The animation to use when showing a drawer with `top` placement."
  1455. },
  1456. {
  1457. "name": "drawer.showEnd",
  1458. "description": "The animation to use when showing a drawer with `end` placement."
  1459. },
  1460. {
  1461. "name": "drawer.showBottom",
  1462. "description": "The animation to use when showing a drawer with `bottom` placement."
  1463. },
  1464. {
  1465. "name": "drawer.showStart",
  1466. "description": "The animation to use when showing a drawer with `start` placement."
  1467. },
  1468. {
  1469. "name": "drawer.hideTop",
  1470. "description": "The animation to use when hiding a drawer with `top` placement."
  1471. },
  1472. {
  1473. "name": "drawer.hideEnd",
  1474. "description": "The animation to use when hiding a drawer with `end` placement."
  1475. },
  1476. {
  1477. "name": "drawer.hideBottom",
  1478. "description": "The animation to use when hiding a drawer with `bottom` placement."
  1479. },
  1480. {
  1481. "name": "drawer.hideStart",
  1482. "description": "The animation to use when hiding a drawer with `start` placement."
  1483. },
  1484. {
  1485. "name": "drawer.overlay.show",
  1486. "description": "The animation to use when showing the drawer's overlay."
  1487. },
  1488. {
  1489. "name": "drawer.overlay.hide",
  1490. "description": "The animation to use when hiding the drawer's overlay.\n"
  1491. }
  1492. ]
  1493. },
  1494. {
  1495. "className": "SlDropdown",
  1496. "tag": "sl-dropdown",
  1497. "file": "src/components/dropdown/dropdown.ts",
  1498. "since": "2.0",
  1499. "status": "stable",
  1500. "props": [
  1501. {
  1502. "name": "closeOnSelect",
  1503. "attribute": "close-on-select",
  1504. "description": "Determines whether the dropdown should hide when a menu item is selected.",
  1505. "type": "boolean",
  1506. "defaultValue": "true"
  1507. },
  1508. {
  1509. "name": "containingElement",
  1510. "description": "The dropdown will close when the user interacts outside of this element (e.g. clicking).",
  1511. "type": "HTMLElement"
  1512. },
  1513. {
  1514. "name": "disabled",
  1515. "description": "Disables the dropdown so the panel will not open.",
  1516. "type": "boolean",
  1517. "defaultValue": "false"
  1518. },
  1519. {
  1520. "name": "distance",
  1521. "description": "The distance in pixels from which to offset the panel away from its trigger.",
  1522. "type": "number",
  1523. "defaultValue": "2"
  1524. },
  1525. {
  1526. "name": "hoist",
  1527. "description": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`.",
  1528. "type": "boolean",
  1529. "defaultValue": "false"
  1530. },
  1531. {
  1532. "name": "open",
  1533. "description": "Indicates whether or not the dropdown is open. You can use this in lieu of the show/hide methods.",
  1534. "type": "boolean",
  1535. "defaultValue": "false"
  1536. },
  1537. {
  1538. "name": "placement",
  1539. "description": "The preferred placement of the dropdown panel. Note that the actual placement may vary as needed to keep the panel\ninside of the viewport.",
  1540. "type": "'top' | 'bottom' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'",
  1541. "values": [
  1542. "top",
  1543. "bottom",
  1544. "top-start",
  1545. "top-end",
  1546. "bottom-start",
  1547. "bottom-end",
  1548. "right",
  1549. "right-start",
  1550. "right-end",
  1551. "left",
  1552. "left-start",
  1553. "left-end"
  1554. ],
  1555. "defaultValue": "'bottom-start'"
  1556. },
  1557. {
  1558. "name": "skidding",
  1559. "description": "The distance in pixels from which to offset the panel along its trigger.",
  1560. "type": "number",
  1561. "defaultValue": "0"
  1562. }
  1563. ],
  1564. "methods": [
  1565. {
  1566. "name": "hide",
  1567. "description": "Hides the dropdown panel",
  1568. "params": []
  1569. },
  1570. {
  1571. "name": "reposition",
  1572. "description": "Instructs the dropdown menu to reposition. Useful when the position or size of the trigger changes when the menu\nis activated.",
  1573. "params": []
  1574. },
  1575. {
  1576. "name": "show",
  1577. "description": "Shows the dropdown panel.",
  1578. "params": []
  1579. }
  1580. ],
  1581. "events": [
  1582. {
  1583. "name": "sl-after-hide",
  1584. "description": "Emitted after the dropdown closes and all animations are complete.",
  1585. "details": "void"
  1586. },
  1587. {
  1588. "name": "sl-after-show",
  1589. "description": "Emitted after the dropdown opens and all animations are complete.",
  1590. "details": "void"
  1591. },
  1592. {
  1593. "name": "sl-hide",
  1594. "description": "Emitted when the dropdown closes.",
  1595. "details": "void"
  1596. },
  1597. {
  1598. "name": "sl-show",
  1599. "description": "Emitted when the dropdown opens.",
  1600. "details": "void"
  1601. }
  1602. ],
  1603. "slots": [
  1604. {
  1605. "name": "trigger",
  1606. "description": "The dropdown's trigger, usually a `<sl-button>` element."
  1607. },
  1608. {
  1609. "name": "",
  1610. "description": "The dropdown's content."
  1611. }
  1612. ],
  1613. "cssCustomProperties": [],
  1614. "parts": [
  1615. {
  1616. "name": "base",
  1617. "description": "The component's base wrapper."
  1618. },
  1619. {
  1620. "name": "trigger",
  1621. "description": "The container that wraps the trigger."
  1622. },
  1623. {
  1624. "name": "panel",
  1625. "description": "The panel that gets shown when the dropdown is open.\n"
  1626. }
  1627. ],
  1628. "dependencies": [],
  1629. "animations": [
  1630. {
  1631. "name": "dropdown.show",
  1632. "description": "The animation to use when showing the dropdown."
  1633. },
  1634. {
  1635. "name": "dropdown.hide",
  1636. "description": "The animation to use when hiding the dropdown.\n"
  1637. }
  1638. ]
  1639. },
  1640. {
  1641. "className": "SlForm",
  1642. "tag": "sl-form",
  1643. "file": "src/components/form/form.ts",
  1644. "since": "2.0",
  1645. "status": "stable",
  1646. "props": [
  1647. {
  1648. "name": "novalidate",
  1649. "description": "Prevent the form from validating inputs before submitting.",
  1650. "type": "boolean",
  1651. "defaultValue": "false"
  1652. }
  1653. ],
  1654. "methods": [
  1655. {
  1656. "name": "getFormControls",
  1657. "description": "Gets all form control elements (native and custom).",
  1658. "params": []
  1659. },
  1660. {
  1661. "name": "getFormData",
  1662. "description": "Serializes all form controls elements and returns a `FormData` object.",
  1663. "params": []
  1664. },
  1665. {
  1666. "name": "submit",
  1667. "description": "Submits the form. If all controls are valid, the `sl-submit` event will be emitted and the promise will resolve\nwith `true`. If any form control is invalid, the promise will resolve with `false` and no event will be emitted.",
  1668. "params": []
  1669. }
  1670. ],
  1671. "events": [
  1672. {
  1673. "name": "sl-submit",
  1674. "description": "Emitted when the form is submitted. This event will not be emitted if any form control inside of\nit is in an invalid state, unless the form has the `novalidate` attribute. Note that there is never a need to prevent\nthis event, since it doen't send a GET or POST request like native forms. To \"prevent\" submission, use a conditional\naround the XHR request you use to submit the form's data with.",
  1675. "details": "{ formControls: HTMLElement[], formData: FormData }"
  1676. }
  1677. ],
  1678. "slots": [
  1679. {
  1680. "name": "",
  1681. "description": "The form's content."
  1682. }
  1683. ],
  1684. "cssCustomProperties": [],
  1685. "parts": [
  1686. {
  1687. "name": "base",
  1688. "description": "The component's base wrapper.\n"
  1689. }
  1690. ],
  1691. "dependencies": [],
  1692. "animations": []
  1693. },
  1694. {
  1695. "className": "SlFormatBytes",
  1696. "tag": "sl-format-bytes",
  1697. "file": "src/components/format-bytes/format-bytes.ts",
  1698. "since": "2.0",
  1699. "status": "stable",
  1700. "props": [
  1701. {
  1702. "name": "locale",
  1703. "description": "The locale to use when formatting the number.",
  1704. "type": "string"
  1705. },
  1706. {
  1707. "name": "unit",
  1708. "description": "The unit to display.",
  1709. "type": "'bytes' | 'bits'",
  1710. "values": [
  1711. "bytes",
  1712. "bits"
  1713. ],
  1714. "defaultValue": "'bytes'"
  1715. },
  1716. {
  1717. "name": "value",
  1718. "description": "The number to format in bytes.",
  1719. "type": "number",
  1720. "defaultValue": "0"
  1721. }
  1722. ],
  1723. "methods": [],
  1724. "events": [],
  1725. "slots": [],
  1726. "cssCustomProperties": [],
  1727. "parts": [],
  1728. "dependencies": [],
  1729. "animations": []
  1730. },
  1731. {
  1732. "className": "SlFormatDate",
  1733. "tag": "sl-format-date",
  1734. "file": "src/components/format-date/format-date.ts",
  1735. "since": "2.0",
  1736. "status": "stable",
  1737. "props": [
  1738. {
  1739. "name": "date",
  1740. "description": "The date/time to format. If not set, the current date and time will be used.",
  1741. "type": "'' | ''",
  1742. "values": [
  1743. "string",
  1744. null
  1745. ],
  1746. "defaultValue": "..."
  1747. },
  1748. {
  1749. "name": "day",
  1750. "description": "The format for displaying the day.",
  1751. "type": "'numeric' | '2-digit'",
  1752. "values": [
  1753. "numeric",
  1754. "2-digit"
  1755. ]
  1756. },
  1757. {
  1758. "name": "era",
  1759. "description": "The format for displaying the era.",
  1760. "type": "'narrow' | 'short' | 'long'",
  1761. "values": [
  1762. "narrow",
  1763. "short",
  1764. "long"
  1765. ]
  1766. },
  1767. {
  1768. "name": "hour",
  1769. "description": "The format for displaying the hour.",
  1770. "type": "'numeric' | '2-digit'",
  1771. "values": [
  1772. "numeric",
  1773. "2-digit"
  1774. ]
  1775. },
  1776. {
  1777. "name": "hourFormat",
  1778. "attribute": "hour-format",
  1779. "description": "When set, 24 hour time will always be used.",
  1780. "type": "'auto' | '12' | '24'",
  1781. "values": [
  1782. "auto",
  1783. "12",
  1784. "24"
  1785. ],
  1786. "defaultValue": "'auto'"
  1787. },
  1788. {
  1789. "name": "locale",
  1790. "description": "The locale to use when formatting the date/time.",
  1791. "type": "string"
  1792. },
  1793. {
  1794. "name": "minute",
  1795. "description": "The format for displaying the minute.",
  1796. "type": "'numeric' | '2-digit'",
  1797. "values": [
  1798. "numeric",
  1799. "2-digit"
  1800. ]
  1801. },
  1802. {
  1803. "name": "month",
  1804. "description": "The format for displaying the month.",
  1805. "type": "'narrow' | 'short' | 'long' | 'numeric' | '2-digit'",
  1806. "values": [
  1807. "narrow",
  1808. "short",
  1809. "long",
  1810. "numeric",
  1811. "2-digit"
  1812. ]
  1813. },
  1814. {
  1815. "name": "second",
  1816. "description": "The format for displaying the second.",
  1817. "type": "'numeric' | '2-digit'",
  1818. "values": [
  1819. "numeric",
  1820. "2-digit"
  1821. ]
  1822. },
  1823. {
  1824. "name": "timeZone",
  1825. "attribute": "time-zone",
  1826. "description": "The time zone to express the time in.",
  1827. "type": "string"
  1828. },
  1829. {
  1830. "name": "timeZoneName",
  1831. "attribute": "time-zone-name",
  1832. "description": "The format for displaying the time.",
  1833. "type": "'short' | 'long'",
  1834. "values": [
  1835. "short",
  1836. "long"
  1837. ]
  1838. },
  1839. {
  1840. "name": "weekday",
  1841. "description": "The format for displaying the weekday.",
  1842. "type": "'narrow' | 'short' | 'long'",
  1843. "values": [
  1844. "narrow",
  1845. "short",
  1846. "long"
  1847. ]
  1848. },
  1849. {
  1850. "name": "year",
  1851. "description": "The format for displaying the year.",
  1852. "type": "'numeric' | '2-digit'",
  1853. "values": [
  1854. "numeric",
  1855. "2-digit"
  1856. ]
  1857. }
  1858. ],
  1859. "methods": [],
  1860. "events": [],
  1861. "slots": [],
  1862. "cssCustomProperties": [],
  1863. "parts": [],
  1864. "dependencies": [],
  1865. "animations": []
  1866. },
  1867. {
  1868. "className": "SlFormatNumber",
  1869. "tag": "sl-format-number",
  1870. "file": "src/components/format-number/format-number.ts",
  1871. "since": "2.0",
  1872. "status": "stable",
  1873. "props": [
  1874. {
  1875. "name": "currency",
  1876. "description": "The currency to use when formatting. Must be an ISO 4217 currency code such as `USD` or `EUR`.",
  1877. "type": "string",
  1878. "defaultValue": "'USD'"
  1879. },
  1880. {
  1881. "name": "currencyDisplay",
  1882. "attribute": "currency-display",
  1883. "description": "How to display the currency.",
  1884. "type": "'symbol' | 'name' | 'code' | 'narrowSymbol'",
  1885. "values": [
  1886. "symbol",
  1887. "name",
  1888. "code",
  1889. "narrowSymbol"
  1890. ],
  1891. "defaultValue": "'symbol'"
  1892. },
  1893. {
  1894. "name": "locale",
  1895. "description": "The locale to use when formatting the number.",
  1896. "type": "string"
  1897. },
  1898. {
  1899. "name": "maximumFractionDigits",
  1900. "attribute": "maximum-fraction-digits",
  1901. "description": "The maximum number of fraction digits to use. Possible values are 0 - 20.",
  1902. "type": "number"
  1903. },
  1904. {
  1905. "name": "maximumSignificantDigits",
  1906. "attribute": "maximum-significant-digits",
  1907. "description": "The maximum number of significant digits to use,. Possible values are 1 - 21.",
  1908. "type": "number"
  1909. },
  1910. {
  1911. "name": "minimumFractionDigits",
  1912. "attribute": "minimum-fraction-digits",
  1913. "description": "The minimum number of fraction digits to use. Possible values are 0 - 20.",
  1914. "type": "number"
  1915. },
  1916. {
  1917. "name": "minimumIntegerDigits",
  1918. "attribute": "minimum-integer-digits",
  1919. "description": "The minimum number of integer digits to use. Possible values are 1 - 21.",
  1920. "type": "number"
  1921. },
  1922. {
  1923. "name": "minimumSignificantDigits",
  1924. "attribute": "minimum-significant-digits",
  1925. "description": "The minimum number of significant digits to use. Possible values are 1 - 21.",
  1926. "type": "number"
  1927. },
  1928. {
  1929. "name": "noGrouping",
  1930. "attribute": "no-grouping",
  1931. "description": "Turns off grouping separators.",
  1932. "type": "boolean",
  1933. "defaultValue": "false"
  1934. },
  1935. {
  1936. "name": "type",
  1937. "description": "The formatting style to use.",
  1938. "type": "'currency' | 'decimal' | 'percent'",
  1939. "values": [
  1940. "currency",
  1941. "decimal",
  1942. "percent"
  1943. ],
  1944. "defaultValue": "'decimal'"
  1945. },
  1946. {
  1947. "name": "value",
  1948. "description": "The number to format.",
  1949. "type": "number",
  1950. "defaultValue": "0"
  1951. }
  1952. ],
  1953. "methods": [],
  1954. "events": [],
  1955. "slots": [],
  1956. "cssCustomProperties": [],
  1957. "parts": [],
  1958. "dependencies": [],
  1959. "animations": []
  1960. },
  1961. {
  1962. "className": "SlIcon",
  1963. "tag": "sl-icon",
  1964. "file": "src/components/icon/icon.ts",
  1965. "since": "2.0",
  1966. "status": "stable",
  1967. "props": [
  1968. {
  1969. "name": "label",
  1970. "description": "An alternative description to use for accessibility. If omitted, the name or src will be used to generate it.",
  1971. "type": "string"
  1972. },
  1973. {
  1974. "name": "library",
  1975. "description": "The name of a registered custom icon library.",
  1976. "type": "string",
  1977. "defaultValue": "'default'"
  1978. },
  1979. {
  1980. "name": "name",
  1981. "description": "The name of the icon to draw.",
  1982. "type": "string"
  1983. },
  1984. {
  1985. "name": "src",
  1986. "description": "An external URL of an SVG file.",
  1987. "type": "string"
  1988. }
  1989. ],
  1990. "methods": [],
  1991. "events": [
  1992. {
  1993. "name": "sl-error",
  1994. "description": "Emitted when the icon failed to load.",
  1995. "details": "{ status: number }"
  1996. },
  1997. {
  1998. "name": "sl-load",
  1999. "description": "Emitted when the icon has loaded.",
  2000. "details": "void"
  2001. }
  2002. ],
  2003. "slots": [],
  2004. "cssCustomProperties": [],
  2005. "parts": [
  2006. {
  2007. "name": "base",
  2008. "description": "The component's base wrapper.\n"
  2009. }
  2010. ],
  2011. "dependencies": [],
  2012. "animations": []
  2013. },
  2014. {
  2015. "className": "SlIconButton",
  2016. "tag": "sl-icon-button",
  2017. "file": "src/components/icon-button/icon-button.ts",
  2018. "since": "2.0",
  2019. "status": "stable",
  2020. "props": [
  2021. {
  2022. "name": "disabled",
  2023. "description": "Disables the button.",
  2024. "type": "boolean",
  2025. "defaultValue": "false"
  2026. },
  2027. {
  2028. "name": "label",
  2029. "description": "A description that gets read by screen readers and other assistive devices. For optimal accessibility, you should\nalways include a label that describes what the icon button does.",
  2030. "type": "string",
  2031. "defaultValue": "''"
  2032. },
  2033. {
  2034. "name": "library",
  2035. "description": "The name of a registered custom icon library.",
  2036. "type": "string"
  2037. },
  2038. {
  2039. "name": "name",
  2040. "description": "The name of the icon to draw.",
  2041. "type": "string"
  2042. },
  2043. {
  2044. "name": "src",
  2045. "description": "An external URL of an SVG file.",
  2046. "type": "string"
  2047. }
  2048. ],
  2049. "methods": [],
  2050. "events": [],
  2051. "slots": [],
  2052. "cssCustomProperties": [],
  2053. "parts": [
  2054. {
  2055. "name": "base",
  2056. "description": "The component's base wrapper.\n"
  2057. }
  2058. ],
  2059. "dependencies": [
  2060. "sl-icon"
  2061. ],
  2062. "animations": []
  2063. },
  2064. {
  2065. "className": "SlImageComparer",
  2066. "tag": "sl-image-comparer",
  2067. "file": "src/components/image-comparer/image-comparer.ts",
  2068. "since": "2.0",
  2069. "status": "stable",
  2070. "props": [
  2071. {
  2072. "name": "position",
  2073. "description": "The position of the divider as a percentage.",
  2074. "type": "number",
  2075. "defaultValue": "50"
  2076. }
  2077. ],
  2078. "methods": [],
  2079. "events": [],
  2080. "slots": [
  2081. {
  2082. "name": "before",
  2083. "description": "The before image, an `<img>` or `<svg>` element."
  2084. },
  2085. {
  2086. "name": "after",
  2087. "description": "The after image, an `<img>` or `<svg>` element."
  2088. },
  2089. {
  2090. "name": "handle-icon",
  2091. "description": "The icon used inside the handle.\n"
  2092. }
  2093. ],
  2094. "cssCustomProperties": [
  2095. {
  2096. "name": "--divider-width",
  2097. "description": "The width of the dividing line."
  2098. },
  2099. {
  2100. "name": "--handle-size",
  2101. "description": "The size of the compare handle.\n"
  2102. }
  2103. ],
  2104. "parts": [
  2105. {
  2106. "name": "base",
  2107. "description": "The component's base wrapper."
  2108. },
  2109. {
  2110. "name": "before",
  2111. "description": "The container that holds the \"before\" image."
  2112. },
  2113. {
  2114. "name": "after",
  2115. "description": "The container that holds the \"after\" image."
  2116. },
  2117. {
  2118. "name": "divider",
  2119. "description": "The divider that separates the images."
  2120. },
  2121. {
  2122. "name": "handle",
  2123. "description": "The handle that the user drags to expose the after image.\n"
  2124. }
  2125. ],
  2126. "dependencies": [
  2127. "sl-icon"
  2128. ],
  2129. "animations": []
  2130. },
  2131. {
  2132. "className": "SlInclude",
  2133. "tag": "sl-include",
  2134. "file": "src/components/include/include.ts",
  2135. "since": "2.0",
  2136. "status": "stable",
  2137. "props": [
  2138. {
  2139. "name": "allowScripts",
  2140. "attribute": "allow-scripts",
  2141. "description": "Allows included scripts to be executed. You must ensure the content you're including is trusted, otherwise this\noption can lead to XSS vulnerabilities in your app!",
  2142. "type": "boolean",
  2143. "defaultValue": "false"
  2144. },
  2145. {
  2146. "name": "mode",
  2147. "description": "The fetch mode to use.",
  2148. "type": "'cors' | 'no-cors' | 'same-origin'",
  2149. "values": [
  2150. "cors",
  2151. "no-cors",
  2152. "same-origin"
  2153. ],
  2154. "defaultValue": "'cors'"
  2155. },
  2156. {
  2157. "name": "src",
  2158. "description": "The location of the HTML file to include.",
  2159. "type": "string"
  2160. }
  2161. ],
  2162. "methods": [],
  2163. "events": [
  2164. {
  2165. "name": "sl-error",
  2166. "description": "Emitted when the included file fails to load due to an error.",
  2167. "details": "{ status: number }"
  2168. },
  2169. {
  2170. "name": "sl-load",
  2171. "description": "Emitted when the included file is loaded.",
  2172. "details": "void"
  2173. }
  2174. ],
  2175. "slots": [],
  2176. "cssCustomProperties": [],
  2177. "parts": [],
  2178. "dependencies": [],
  2179. "animations": []
  2180. },
  2181. {
  2182. "className": "SlInput",
  2183. "tag": "sl-input",
  2184. "file": "src/components/input/input.ts",
  2185. "since": "2.0",
  2186. "status": "stable",
  2187. "props": [
  2188. {
  2189. "name": "autocapitalize",
  2190. "description": "The input's autocaptialize attribute.",
  2191. "type": "'none' | 'off' | 'on' | 'sentences' | 'words' | 'characters'",
  2192. "values": [
  2193. "none",
  2194. "off",
  2195. "on",
  2196. "sentences",
  2197. "words",
  2198. "characters"
  2199. ]
  2200. },
  2201. {
  2202. "name": "autocomplete",
  2203. "description": "The input's autocomplete attribute.",
  2204. "type": "string"
  2205. },
  2206. {
  2207. "name": "autocorrect",
  2208. "description": "The input's autocorrect attribute.",
  2209. "type": "string"
  2210. },
  2211. {
  2212. "name": "autofocus",
  2213. "description": "The input's autofocus attribute.",
  2214. "type": "boolean"
  2215. },
  2216. {
  2217. "name": "clearable",
  2218. "description": "Adds a clear button when the input is populated.",
  2219. "type": "boolean",
  2220. "defaultValue": "false"
  2221. },
  2222. {
  2223. "name": "disabled",
  2224. "description": "Disables the input.",
  2225. "type": "boolean",
  2226. "defaultValue": "false"
  2227. },
  2228. {
  2229. "name": "helpText",
  2230. "attribute": "help-text",
  2231. "description": "The input's help text. Alternatively, you can use the help-text slot.",
  2232. "type": "string",
  2233. "defaultValue": "''"
  2234. },
  2235. {
  2236. "name": "inputmode",
  2237. "description": "The input's inputmode attribute.",
  2238. "type": "'none' | 'text' | 'numeric' | 'decimal' | 'email' | 'search' | 'tel' | 'url'",
  2239. "values": [
  2240. "none",
  2241. "text",
  2242. "numeric",
  2243. "decimal",
  2244. "email",
  2245. "search",
  2246. "tel",
  2247. "url"
  2248. ]
  2249. },
  2250. {
  2251. "name": "invalid",
  2252. "description": "This will be true when the control is in an invalid state. Validity is determined by props such as `type`,\n`required`, `minlength`, `maxlength`, and `pattern` using the browser's constraint validation API.",
  2253. "type": "boolean",
  2254. "defaultValue": "false"
  2255. },
  2256. {
  2257. "name": "label",
  2258. "description": "The input's label. Alternatively, you can use the label slot.",
  2259. "type": "string"
  2260. },
  2261. {
  2262. "name": "max",
  2263. "description": "The input's maximum value.",
  2264. "type": "string | number",
  2265. "values": [
  2266. "string",
  2267. "number"
  2268. ]
  2269. },
  2270. {
  2271. "name": "maxlength",
  2272. "description": "The maximum length of input that will be considered valid.",
  2273. "type": "number"
  2274. },
  2275. {
  2276. "name": "min",
  2277. "description": "The input's minimum value.",
  2278. "type": "string | number",
  2279. "values": [
  2280. "string",
  2281. "number"
  2282. ]
  2283. },
  2284. {
  2285. "name": "minlength",
  2286. "description": "The minimum length of input that will be considered valid.",
  2287. "type": "number"
  2288. },
  2289. {
  2290. "name": "name",
  2291. "description": "The input's name attribute.",
  2292. "type": "string"
  2293. },
  2294. {
  2295. "name": "pattern",
  2296. "description": "A pattern to validate input against.",
  2297. "type": "string"
  2298. },
  2299. {
  2300. "name": "pill",
  2301. "description": "Draws a pill-style input with rounded edges.",
  2302. "type": "boolean",
  2303. "defaultValue": "false"
  2304. },
  2305. {
  2306. "name": "placeholder",
  2307. "description": "The input's placeholder text.",
  2308. "type": "string"
  2309. },
  2310. {
  2311. "name": "readonly",
  2312. "description": "Makes the input readonly.",
  2313. "type": "boolean",
  2314. "defaultValue": "false"
  2315. },
  2316. {
  2317. "name": "required",
  2318. "description": "Makes the input a required field.",
  2319. "type": "boolean",
  2320. "defaultValue": "false"
  2321. },
  2322. {
  2323. "name": "size",
  2324. "description": "The input's size.",
  2325. "type": "'small' | 'medium' | 'large'",
  2326. "values": [
  2327. "small",
  2328. "medium",
  2329. "large"
  2330. ],
  2331. "defaultValue": "'medium'"
  2332. },
  2333. {
  2334. "name": "spellcheck",
  2335. "description": "Enables spell checking on the input.",
  2336. "type": "boolean"
  2337. },
  2338. {
  2339. "name": "step",
  2340. "description": "The input's step attribute.",
  2341. "type": "number"
  2342. },
  2343. {
  2344. "name": "togglePassword",
  2345. "attribute": "toggle-password",
  2346. "description": "Adds a password toggle button to password inputs.",
  2347. "type": "boolean",
  2348. "defaultValue": "false"
  2349. },
  2350. {
  2351. "name": "type",
  2352. "description": "The input's type.",
  2353. "type": "'number' | 'text' | 'email' | 'password' | 'search' | 'tel' | 'url'",
  2354. "values": [
  2355. "number",
  2356. "text",
  2357. "email",
  2358. "password",
  2359. "search",
  2360. "tel",
  2361. "url"
  2362. ],
  2363. "defaultValue": "'text'"
  2364. },
  2365. {
  2366. "name": "value",
  2367. "description": "The input's value attribute.",
  2368. "type": "string",
  2369. "defaultValue": "''"
  2370. }
  2371. ],
  2372. "methods": [
  2373. {
  2374. "name": "blur",
  2375. "description": "Removes focus from the input.",
  2376. "params": []
  2377. },
  2378. {
  2379. "name": "focus",
  2380. "description": "Sets focus on the input.",
  2381. "params": [
  2382. {
  2383. "name": "options",
  2384. "type": "FocusOptions",
  2385. "isOptional": true
  2386. }
  2387. ]
  2388. },
  2389. {
  2390. "name": "reportValidity",
  2391. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  2392. "params": []
  2393. },
  2394. {
  2395. "name": "select",
  2396. "description": "Selects all the text in the input.",
  2397. "params": []
  2398. },
  2399. {
  2400. "name": "setCustomValidity",
  2401. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  2402. "params": [
  2403. {
  2404. "name": "message",
  2405. "type": "string"
  2406. }
  2407. ]
  2408. },
  2409. {
  2410. "name": "setRangeText",
  2411. "description": "Replaces a range of text with a new string.",
  2412. "params": [
  2413. {
  2414. "name": "replacement",
  2415. "type": "string"
  2416. },
  2417. {
  2418. "name": "start",
  2419. "type": "number"
  2420. },
  2421. {
  2422. "name": "end",
  2423. "type": "number"
  2424. },
  2425. {
  2426. "name": "selectMode",
  2427. "type": "'end' | 'start' | 'select' | 'preserve'",
  2428. "values": [
  2429. "end",
  2430. "start",
  2431. "select",
  2432. "preserve"
  2433. ],
  2434. "defaultValue": "'preserve'"
  2435. }
  2436. ]
  2437. },
  2438. {
  2439. "name": "setSelectionRange",
  2440. "description": "Sets the start and end positions of the text selection (0-based).",
  2441. "params": [
  2442. {
  2443. "name": "selectionStart",
  2444. "type": "number"
  2445. },
  2446. {
  2447. "name": "selectionEnd",
  2448. "type": "number"
  2449. },
  2450. {
  2451. "name": "selectionDirection",
  2452. "type": "'none' | 'forward' | 'backward'",
  2453. "values": [
  2454. "none",
  2455. "forward",
  2456. "backward"
  2457. ],
  2458. "defaultValue": "'none'"
  2459. }
  2460. ]
  2461. }
  2462. ],
  2463. "events": [
  2464. {
  2465. "name": "sl-blur",
  2466. "description": "Emitted when the control loses focus.",
  2467. "details": "void"
  2468. },
  2469. {
  2470. "name": "sl-change",
  2471. "description": "Emitted when the control's value changes.",
  2472. "details": "void"
  2473. },
  2474. {
  2475. "name": "sl-clear",
  2476. "description": "Emitted when the clear button is activated.",
  2477. "details": "void"
  2478. },
  2479. {
  2480. "name": "sl-focus",
  2481. "description": "Emitted when the control gains focus.",
  2482. "details": "void"
  2483. },
  2484. {
  2485. "name": "sl-input",
  2486. "description": "Emitted when the control receives input.",
  2487. "details": "void"
  2488. }
  2489. ],
  2490. "slots": [
  2491. {
  2492. "name": "label",
  2493. "description": "The input's label. Alternatively, you can use the label prop."
  2494. },
  2495. {
  2496. "name": "prefix",
  2497. "description": "Used to prepend an icon or similar element to the input."
  2498. },
  2499. {
  2500. "name": "suffix",
  2501. "description": "Used to append an icon or similar element to the input."
  2502. },
  2503. {
  2504. "name": "clear-icon",
  2505. "description": "An icon to use in lieu of the default clear icon."
  2506. },
  2507. {
  2508. "name": "show-password-icon",
  2509. "description": "An icon to use in lieu of the default show password icon."
  2510. },
  2511. {
  2512. "name": "hide-password-icon",
  2513. "description": "An icon to use in lieu of the default hide password icon."
  2514. },
  2515. {
  2516. "name": "help-text",
  2517. "description": "Help text that describes how to use the input. Alternatively, you can use the help-text prop.\n"
  2518. }
  2519. ],
  2520. "cssCustomProperties": [
  2521. {
  2522. "name": "--focus-ring",
  2523. "description": "The focus ring style to use when the control receives focus, a `box-shadow` property.\n"
  2524. }
  2525. ],
  2526. "parts": [
  2527. {
  2528. "name": "base",
  2529. "description": "The component's base wrapper."
  2530. },
  2531. {
  2532. "name": "form-control",
  2533. "description": "The form control that wraps the label, input, and help-text."
  2534. },
  2535. {
  2536. "name": "label",
  2537. "description": "The input label."
  2538. },
  2539. {
  2540. "name": "input",
  2541. "description": "The input control."
  2542. },
  2543. {
  2544. "name": "prefix",
  2545. "description": "The input prefix container."
  2546. },
  2547. {
  2548. "name": "clear-button",
  2549. "description": "The clear button."
  2550. },
  2551. {
  2552. "name": "password-toggle-button",
  2553. "description": "The password toggle button."
  2554. },
  2555. {
  2556. "name": "suffix",
  2557. "description": "The input suffix container."
  2558. },
  2559. {
  2560. "name": "help-text",
  2561. "description": "The input help text.\n"
  2562. }
  2563. ],
  2564. "dependencies": [
  2565. "sl-icon"
  2566. ],
  2567. "animations": []
  2568. },
  2569. {
  2570. "className": "SlMenu",
  2571. "tag": "sl-menu",
  2572. "file": "src/components/menu/menu.ts",
  2573. "since": "2.0",
  2574. "status": "stable",
  2575. "props": [],
  2576. "methods": [
  2577. {
  2578. "name": "typeToSelect",
  2579. "description": "Initiates type-to-select logic, which automatically selects an option based on what the user is currently typing.\nThe key passed will be appended to the internal query and the selection will be updated. After a brief period, the\ninternal query is cleared automatically. This method is intended to be used with the keydown event. Useful for\nenabling type-to-select when the menu doesn't have focus.",
  2580. "params": [
  2581. {
  2582. "name": "key",
  2583. "type": "string"
  2584. }
  2585. ]
  2586. }
  2587. ],
  2588. "events": [
  2589. {
  2590. "name": "sl-select",
  2591. "description": "Emitted when a menu item is selected.",
  2592. "details": "{ item: SlMenuItem }"
  2593. }
  2594. ],
  2595. "slots": [
  2596. {
  2597. "name": "",
  2598. "description": "The menu's content, including menu items, menu dividers, and menu labels."
  2599. }
  2600. ],
  2601. "cssCustomProperties": [],
  2602. "parts": [
  2603. {
  2604. "name": "base",
  2605. "description": "The component's base wrapper.\n"
  2606. }
  2607. ],
  2608. "dependencies": [],
  2609. "animations": []
  2610. },
  2611. {
  2612. "className": "SlMenuDivider",
  2613. "tag": "sl-menu-divider",
  2614. "file": "src/components/menu-divider/menu-divider.ts",
  2615. "since": "2.0",
  2616. "status": "stable",
  2617. "props": [],
  2618. "methods": [],
  2619. "events": [],
  2620. "slots": [],
  2621. "cssCustomProperties": [],
  2622. "parts": [
  2623. {
  2624. "name": "base",
  2625. "description": "The component's base wrapper.\n"
  2626. }
  2627. ],
  2628. "dependencies": [
  2629. "sl-menu"
  2630. ],
  2631. "animations": []
  2632. },
  2633. {
  2634. "className": "SlMenuItem",
  2635. "tag": "sl-menu-item",
  2636. "file": "src/components/menu-item/menu-item.ts",
  2637. "since": "2.0",
  2638. "status": "stable",
  2639. "props": [
  2640. {
  2641. "name": "checked",
  2642. "description": "Draws the item in a checked state.",
  2643. "type": "boolean",
  2644. "defaultValue": "false"
  2645. },
  2646. {
  2647. "name": "disabled",
  2648. "description": "Draws the menu item in a disabled state.",
  2649. "type": "boolean",
  2650. "defaultValue": "false"
  2651. },
  2652. {
  2653. "name": "value",
  2654. "description": "A unique value to store in the menu item. This can be used as a way to identify menu items when selected.",
  2655. "type": "string",
  2656. "defaultValue": "''"
  2657. }
  2658. ],
  2659. "methods": [
  2660. {
  2661. "name": "blur",
  2662. "description": "Removes focus from the button.",
  2663. "params": []
  2664. },
  2665. {
  2666. "name": "focus",
  2667. "description": "Sets focus on the button.",
  2668. "params": [
  2669. {
  2670. "name": "options",
  2671. "type": "FocusOptions",
  2672. "isOptional": true
  2673. }
  2674. ]
  2675. }
  2676. ],
  2677. "events": [],
  2678. "slots": [
  2679. {
  2680. "name": "",
  2681. "description": "The menu item's label."
  2682. },
  2683. {
  2684. "name": "prefix",
  2685. "description": "Used to prepend an icon or similar element to the menu item."
  2686. },
  2687. {
  2688. "name": "suffix",
  2689. "description": "Used to append an icon or similar element to the menu item.\n"
  2690. }
  2691. ],
  2692. "cssCustomProperties": [],
  2693. "parts": [
  2694. {
  2695. "name": "base",
  2696. "description": "The component's base wrapper."
  2697. },
  2698. {
  2699. "name": "checked-icon",
  2700. "description": "The container that wraps the checked icon."
  2701. },
  2702. {
  2703. "name": "prefix",
  2704. "description": "The prefix container."
  2705. },
  2706. {
  2707. "name": "label",
  2708. "description": "The menu item label."
  2709. },
  2710. {
  2711. "name": "suffix",
  2712. "description": "The suffix container.\n"
  2713. }
  2714. ],
  2715. "dependencies": [
  2716. "sl-icon"
  2717. ],
  2718. "animations": []
  2719. },
  2720. {
  2721. "className": "SlMenuLabel",
  2722. "tag": "sl-menu-label",
  2723. "file": "src/components/menu-label/menu-label.ts",
  2724. "since": "2.0",
  2725. "status": "stable",
  2726. "props": [],
  2727. "methods": [],
  2728. "events": [],
  2729. "slots": [
  2730. {
  2731. "name": "",
  2732. "description": "The menu label's content."
  2733. }
  2734. ],
  2735. "cssCustomProperties": [],
  2736. "parts": [
  2737. {
  2738. "name": "base",
  2739. "description": "The component's base wrapper.\n"
  2740. }
  2741. ],
  2742. "dependencies": [
  2743. "sl-menu"
  2744. ],
  2745. "animations": []
  2746. },
  2747. {
  2748. "className": "SlProgressBar",
  2749. "tag": "sl-progress-bar",
  2750. "file": "src/components/progress-bar/progress-bar.ts",
  2751. "since": "2.0",
  2752. "status": "stable",
  2753. "props": [
  2754. {
  2755. "name": "indeterminate",
  2756. "description": "When true, percentage is ignored, the label is hidden, and the progress bar is drawn in an indeterminate state.",
  2757. "type": "boolean",
  2758. "defaultValue": "false"
  2759. },
  2760. {
  2761. "name": "percentage",
  2762. "description": "The progress bar's percentage, 0 to 100.",
  2763. "type": "number",
  2764. "defaultValue": "0"
  2765. }
  2766. ],
  2767. "methods": [],
  2768. "events": [],
  2769. "slots": [
  2770. {
  2771. "name": "",
  2772. "description": "A label to show inside the indicator."
  2773. }
  2774. ],
  2775. "cssCustomProperties": [
  2776. {
  2777. "name": "--height",
  2778. "description": "The progress bar's height."
  2779. },
  2780. {
  2781. "name": "--track-color",
  2782. "description": "The track color."
  2783. },
  2784. {
  2785. "name": "--indicator-color",
  2786. "description": "The indicator color."
  2787. },
  2788. {
  2789. "name": "--label-color",
  2790. "description": "The label color.\n"
  2791. }
  2792. ],
  2793. "parts": [
  2794. {
  2795. "name": "base",
  2796. "description": "The component's base wrapper."
  2797. },
  2798. {
  2799. "name": "indicator",
  2800. "description": "The progress bar indicator."
  2801. },
  2802. {
  2803. "name": "label",
  2804. "description": "The progress bar label.\n"
  2805. }
  2806. ],
  2807. "dependencies": [],
  2808. "animations": []
  2809. },
  2810. {
  2811. "className": "SlProgressRing",
  2812. "tag": "sl-progress-ring",
  2813. "file": "src/components/progress-ring/progress-ring.ts",
  2814. "since": "2.0",
  2815. "status": "stable",
  2816. "props": [
  2817. {
  2818. "name": "percentage",
  2819. "description": "The current progress percentage, 0 - 100.",
  2820. "type": "number"
  2821. },
  2822. {
  2823. "name": "size",
  2824. "description": "The size of the progress ring in pixels.",
  2825. "type": "number",
  2826. "defaultValue": "128"
  2827. },
  2828. {
  2829. "name": "strokeWidth",
  2830. "attribute": "stroke-width",
  2831. "description": "The stroke width of the progress ring in pixels.",
  2832. "type": "number",
  2833. "defaultValue": "4"
  2834. }
  2835. ],
  2836. "methods": [],
  2837. "events": [],
  2838. "slots": [
  2839. {
  2840. "name": "",
  2841. "description": "A label to show inside the ring."
  2842. }
  2843. ],
  2844. "cssCustomProperties": [
  2845. {
  2846. "name": "--track-color",
  2847. "description": "The track color."
  2848. },
  2849. {
  2850. "name": "--indicator-color",
  2851. "description": "The indicator color.\n"
  2852. }
  2853. ],
  2854. "parts": [
  2855. {
  2856. "name": "base",
  2857. "description": "The component's base wrapper."
  2858. },
  2859. {
  2860. "name": "label",
  2861. "description": "The progress ring label.\n"
  2862. }
  2863. ],
  2864. "dependencies": [],
  2865. "animations": []
  2866. },
  2867. {
  2868. "className": "SlQrCode",
  2869. "tag": "sl-qr-code",
  2870. "file": "src/components/qr-code/qr-code.ts",
  2871. "since": "2.0",
  2872. "status": "experimental",
  2873. "props": [
  2874. {
  2875. "name": "background",
  2876. "description": "The background color. This can be any valid CSS color or `transparent`, but not a CSS custom property.",
  2877. "type": "string",
  2878. "defaultValue": "'#fff'"
  2879. },
  2880. {
  2881. "name": "errorCorrection",
  2882. "attribute": "error-correction",
  2883. "description": "The level of error correction to use.",
  2884. "type": "'L' | 'M' | 'Q' | 'H'",
  2885. "values": [
  2886. "L",
  2887. "M",
  2888. "Q",
  2889. "H"
  2890. ],
  2891. "defaultValue": "'H'"
  2892. },
  2893. {
  2894. "name": "fill",
  2895. "description": "The fill color. This can be any valid CSS color, but not a CSS custom property.",
  2896. "type": "string",
  2897. "defaultValue": "'#000'"
  2898. },
  2899. {
  2900. "name": "label",
  2901. "description": "The label used when screen readers announce the code. If unspecified, the value will be used.",
  2902. "type": "string",
  2903. "defaultValue": "''"
  2904. },
  2905. {
  2906. "name": "radius",
  2907. "description": "The edge radius of each module. Must be between 0 and 0.5.",
  2908. "type": "number",
  2909. "defaultValue": "0"
  2910. },
  2911. {
  2912. "name": "size",
  2913. "description": "The size of the code's overall square in pixels.",
  2914. "type": "number",
  2915. "defaultValue": "128"
  2916. },
  2917. {
  2918. "name": "value",
  2919. "description": "The QR code's value.",
  2920. "type": "string",
  2921. "defaultValue": "''"
  2922. }
  2923. ],
  2924. "methods": [],
  2925. "events": [],
  2926. "slots": [],
  2927. "cssCustomProperties": [],
  2928. "parts": [
  2929. {
  2930. "name": "base",
  2931. "description": "The component's base wrapper.\n"
  2932. }
  2933. ],
  2934. "dependencies": [],
  2935. "animations": []
  2936. },
  2937. {
  2938. "className": "SlRadio",
  2939. "tag": "sl-radio",
  2940. "file": "src/components/radio/radio.ts",
  2941. "since": "2.0",
  2942. "status": "stable",
  2943. "props": [
  2944. {
  2945. "name": "checked",
  2946. "description": "Draws the radio in a checked state.",
  2947. "type": "boolean",
  2948. "defaultValue": "false"
  2949. },
  2950. {
  2951. "name": "disabled",
  2952. "description": "Disables the radio.",
  2953. "type": "boolean",
  2954. "defaultValue": "false"
  2955. },
  2956. {
  2957. "name": "invalid",
  2958. "description": "This will be true when the control is in an invalid state. Validity in range inputs is determined by the message\nprovided by the `setCustomValidity` method.",
  2959. "type": "boolean",
  2960. "defaultValue": "false"
  2961. },
  2962. {
  2963. "name": "name",
  2964. "description": "The radio's name attribute.",
  2965. "type": "string"
  2966. },
  2967. {
  2968. "name": "value",
  2969. "description": "The radio's value attribute.",
  2970. "type": "string"
  2971. }
  2972. ],
  2973. "methods": [
  2974. {
  2975. "name": "blur",
  2976. "description": "Removes focus from the radio.",
  2977. "params": []
  2978. },
  2979. {
  2980. "name": "click",
  2981. "description": "Simulates a click on the radio.",
  2982. "params": []
  2983. },
  2984. {
  2985. "name": "focus",
  2986. "description": "Sets focus on the radio.",
  2987. "params": [
  2988. {
  2989. "name": "options",
  2990. "type": "FocusOptions",
  2991. "isOptional": true
  2992. }
  2993. ]
  2994. },
  2995. {
  2996. "name": "reportValidity",
  2997. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  2998. "params": []
  2999. },
  3000. {
  3001. "name": "setCustomValidity",
  3002. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  3003. "params": [
  3004. {
  3005. "name": "message",
  3006. "type": "string"
  3007. }
  3008. ]
  3009. }
  3010. ],
  3011. "events": [
  3012. {
  3013. "name": "sl-blur",
  3014. "description": "Emitted when the control loses focus.",
  3015. "details": "void"
  3016. },
  3017. {
  3018. "name": "sl-change",
  3019. "description": "Emitted when the control's checked state changes.",
  3020. "details": "void"
  3021. },
  3022. {
  3023. "name": "sl-focus",
  3024. "description": "Emitted when the control gains focus.",
  3025. "details": "void"
  3026. }
  3027. ],
  3028. "slots": [
  3029. {
  3030. "name": "",
  3031. "description": "The radio's label."
  3032. }
  3033. ],
  3034. "cssCustomProperties": [],
  3035. "parts": [
  3036. {
  3037. "name": "base",
  3038. "description": "The component's base wrapper."
  3039. },
  3040. {
  3041. "name": "control",
  3042. "description": "The radio control."
  3043. },
  3044. {
  3045. "name": "checked-icon",
  3046. "description": "The container the wraps the checked icon."
  3047. },
  3048. {
  3049. "name": "label",
  3050. "description": "The radio label.\n"
  3051. }
  3052. ],
  3053. "dependencies": [],
  3054. "animations": []
  3055. },
  3056. {
  3057. "className": "SlRadioGroup",
  3058. "tag": "sl-radio-group",
  3059. "file": "src/components/radio-group/radio-group.ts",
  3060. "since": "2.0",
  3061. "status": "stable",
  3062. "props": [
  3063. {
  3064. "name": "label",
  3065. "description": "The radio group label. Required for proper accessibility. Alternatively, you can use the label slot.",
  3066. "type": "string",
  3067. "defaultValue": "''"
  3068. },
  3069. {
  3070. "name": "noFieldset",
  3071. "attribute": "no-fieldset",
  3072. "description": "Hides the fieldset and legend that surrounds the radio group. The label will still be read by screen readers.",
  3073. "type": "boolean",
  3074. "defaultValue": "false"
  3075. }
  3076. ],
  3077. "methods": [],
  3078. "events": [],
  3079. "slots": [
  3080. {
  3081. "name": "",
  3082. "description": "The default slot where radio controls are placed."
  3083. },
  3084. {
  3085. "name": "label",
  3086. "description": "The radio group label. Required for proper accessibility. Alternatively, you can use the label prop.\n"
  3087. }
  3088. ],
  3089. "cssCustomProperties": [],
  3090. "parts": [
  3091. {
  3092. "name": "base",
  3093. "description": "The component's base wrapper."
  3094. },
  3095. {
  3096. "name": "label",
  3097. "description": "The radio group label.\n"
  3098. }
  3099. ],
  3100. "dependencies": [],
  3101. "animations": []
  3102. },
  3103. {
  3104. "className": "SlRange",
  3105. "tag": "sl-range",
  3106. "file": "src/components/range/range.ts",
  3107. "since": "2.0",
  3108. "status": "stable",
  3109. "props": [
  3110. {
  3111. "name": "disabled",
  3112. "description": "Disables the input.",
  3113. "type": "boolean",
  3114. "defaultValue": "false"
  3115. },
  3116. {
  3117. "name": "helpText",
  3118. "attribute": "help-text",
  3119. "description": "The range's help text. Alternatively, you can use the help-text slot.",
  3120. "type": "string",
  3121. "defaultValue": "''"
  3122. },
  3123. {
  3124. "name": "invalid",
  3125. "description": "This will be true when the control is in an invalid state. Validity in range inputs is determined by the message\nprovided by the `setCustomValidity` method.",
  3126. "type": "boolean",
  3127. "defaultValue": "false"
  3128. },
  3129. {
  3130. "name": "label",
  3131. "description": "The range's label. Alternatively, you can use the label slot.",
  3132. "type": "string",
  3133. "defaultValue": "''"
  3134. },
  3135. {
  3136. "name": "max",
  3137. "description": "The input's max attribute.",
  3138. "type": "number",
  3139. "defaultValue": "100"
  3140. },
  3141. {
  3142. "name": "min",
  3143. "description": "The input's min attribute.",
  3144. "type": "number",
  3145. "defaultValue": "0"
  3146. },
  3147. {
  3148. "name": "name",
  3149. "description": "The input's name attribute.",
  3150. "type": "string",
  3151. "defaultValue": "''"
  3152. },
  3153. {
  3154. "name": "step",
  3155. "description": "The input's step attribute.",
  3156. "type": "number",
  3157. "defaultValue": "1"
  3158. },
  3159. {
  3160. "name": "tooltip",
  3161. "description": "The preferred placedment of the tooltip.",
  3162. "type": "'none' | 'top' | 'bottom'",
  3163. "values": [
  3164. "none",
  3165. "top",
  3166. "bottom"
  3167. ],
  3168. "defaultValue": "'top'"
  3169. },
  3170. {
  3171. "name": "value",
  3172. "description": "The input's value attribute.",
  3173. "type": "number",
  3174. "defaultValue": "0"
  3175. }
  3176. ],
  3177. "methods": [
  3178. {
  3179. "name": "blur",
  3180. "description": "Removes focus from the input.",
  3181. "params": []
  3182. },
  3183. {
  3184. "name": "focus",
  3185. "description": "Sets focus on the input.",
  3186. "params": [
  3187. {
  3188. "name": "options",
  3189. "type": "FocusOptions",
  3190. "isOptional": true
  3191. }
  3192. ]
  3193. },
  3194. {
  3195. "name": "setCustomValidity",
  3196. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  3197. "params": [
  3198. {
  3199. "name": "message",
  3200. "type": "string"
  3201. }
  3202. ]
  3203. },
  3204. {
  3205. "name": "tooltipFormatter",
  3206. "description": "A function used to format the tooltip's value.",
  3207. "params": [
  3208. {
  3209. "name": "value",
  3210. "type": "number"
  3211. }
  3212. ]
  3213. }
  3214. ],
  3215. "events": [
  3216. {
  3217. "name": "sl-blur",
  3218. "description": "Emitted when the control loses focus.",
  3219. "details": "void"
  3220. },
  3221. {
  3222. "name": "sl-change",
  3223. "description": "Emitted when the control's value changes.",
  3224. "details": "void"
  3225. },
  3226. {
  3227. "name": "sl-focus",
  3228. "description": "Emitted when the control gains focus.",
  3229. "details": "void"
  3230. }
  3231. ],
  3232. "slots": [
  3233. {
  3234. "name": "label",
  3235. "description": "The input's label. Alternatively, you can use the label prop."
  3236. },
  3237. {
  3238. "name": "help-text",
  3239. "description": "Help text that describes how to use the input. Alternatively, you can use the help-text prop.\n"
  3240. }
  3241. ],
  3242. "cssCustomProperties": [],
  3243. "parts": [
  3244. {
  3245. "name": "base",
  3246. "description": "The component's base wrapper."
  3247. },
  3248. {
  3249. "name": "input",
  3250. "description": "The native range input."
  3251. },
  3252. {
  3253. "name": "tooltip",
  3254. "description": "The range tooltip.\n"
  3255. }
  3256. ],
  3257. "dependencies": [],
  3258. "animations": []
  3259. },
  3260. {
  3261. "className": "SlRating",
  3262. "tag": "sl-rating",
  3263. "file": "src/components/rating/rating.ts",
  3264. "since": "2.0",
  3265. "status": "stable",
  3266. "props": [
  3267. {
  3268. "name": "disabled",
  3269. "description": "Disables the rating.",
  3270. "type": "boolean",
  3271. "defaultValue": "false"
  3272. },
  3273. {
  3274. "name": "max",
  3275. "description": "The highest rating to show.",
  3276. "type": "number",
  3277. "defaultValue": "5"
  3278. },
  3279. {
  3280. "name": "precision",
  3281. "description": "The minimum increment value allowed by the control.",
  3282. "type": "number",
  3283. "defaultValue": "1"
  3284. },
  3285. {
  3286. "name": "readonly",
  3287. "description": "Makes the rating readonly.",
  3288. "type": "boolean",
  3289. "defaultValue": "false"
  3290. },
  3291. {
  3292. "name": "value",
  3293. "description": "The current rating.",
  3294. "type": "number",
  3295. "defaultValue": "0"
  3296. }
  3297. ],
  3298. "methods": [
  3299. {
  3300. "name": "blur",
  3301. "description": "Removes focus from the rating.",
  3302. "params": []
  3303. },
  3304. {
  3305. "name": "focus",
  3306. "description": "Sets focus on the rating.",
  3307. "params": [
  3308. {
  3309. "name": "options",
  3310. "type": "FocusOptions",
  3311. "isOptional": true
  3312. }
  3313. ]
  3314. },
  3315. {
  3316. "name": "getSymbol",
  3317. "description": "The name of the icon to display as the symbol.",
  3318. "params": [
  3319. {
  3320. "name": "value",
  3321. "type": "number",
  3322. "isOptional": true
  3323. }
  3324. ]
  3325. }
  3326. ],
  3327. "events": [
  3328. {
  3329. "name": "sl-change",
  3330. "description": "Emitted when the rating's value changes.",
  3331. "details": "void"
  3332. }
  3333. ],
  3334. "slots": [],
  3335. "cssCustomProperties": [
  3336. {
  3337. "name": "--symbol-color",
  3338. "description": "The inactive color for symbols."
  3339. },
  3340. {
  3341. "name": "--symbol-color-active",
  3342. "description": "The active color for symbols."
  3343. },
  3344. {
  3345. "name": "--symbol-size",
  3346. "description": "The size of symbols."
  3347. },
  3348. {
  3349. "name": "--symbol-spacing",
  3350. "description": "The spacing to use around symbols.\n"
  3351. }
  3352. ],
  3353. "parts": [
  3354. {
  3355. "name": "base",
  3356. "description": "The component's base wrapper.\n"
  3357. }
  3358. ],
  3359. "dependencies": [
  3360. "sl-icon"
  3361. ],
  3362. "animations": []
  3363. },
  3364. {
  3365. "className": "SlRelativeTime",
  3366. "tag": "sl-relative-time",
  3367. "file": "src/components/relative-time/relative-time.ts",
  3368. "since": "2.0",
  3369. "status": "stable",
  3370. "props": [
  3371. {
  3372. "name": "date",
  3373. "description": "The date from which to calculate time from.",
  3374. "type": "'' | ''",
  3375. "values": [
  3376. "string",
  3377. null
  3378. ]
  3379. },
  3380. {
  3381. "name": "format",
  3382. "description": "The formatting style to use.",
  3383. "type": "'narrow' | 'short' | 'long'",
  3384. "values": [
  3385. "narrow",
  3386. "short",
  3387. "long"
  3388. ],
  3389. "defaultValue": "'long'"
  3390. },
  3391. {
  3392. "name": "locale",
  3393. "description": "The locale to use when formatting the number.",
  3394. "type": "string"
  3395. },
  3396. {
  3397. "name": "numeric",
  3398. "description": "When `auto`, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When `always`, values such as\n\"1 day ago\" and \"in 1 day\" will be shown.",
  3399. "type": "'auto' | 'always'",
  3400. "values": [
  3401. "auto",
  3402. "always"
  3403. ],
  3404. "defaultValue": "'auto'"
  3405. },
  3406. {
  3407. "name": "sync",
  3408. "description": "Keep the displayed value up to date as time passes.",
  3409. "type": "boolean",
  3410. "defaultValue": "false"
  3411. }
  3412. ],
  3413. "methods": [],
  3414. "events": [],
  3415. "slots": [],
  3416. "cssCustomProperties": [],
  3417. "parts": [],
  3418. "dependencies": [],
  3419. "animations": []
  3420. },
  3421. {
  3422. "className": "SlResizeObserver",
  3423. "tag": "sl-resize-observer",
  3424. "file": "src/components/resize-observer/resize-observer.ts",
  3425. "since": "2.0",
  3426. "status": "stable",
  3427. "props": [],
  3428. "methods": [],
  3429. "events": [
  3430. {
  3431. "name": "sl-resize",
  3432. "description": "Emitted when the element is resized.",
  3433. "details": "{ entries: ResizeObserverEntry[] }"
  3434. }
  3435. ],
  3436. "slots": [],
  3437. "cssCustomProperties": [],
  3438. "parts": [],
  3439. "dependencies": [],
  3440. "animations": []
  3441. },
  3442. {
  3443. "className": "SlResponsiveMedia",
  3444. "tag": "sl-responsive-media",
  3445. "file": "src/components/responsive-media/responsive-media.ts",
  3446. "since": "2.0",
  3447. "status": "stable",
  3448. "props": [
  3449. {
  3450. "name": "aspectRatio",
  3451. "attribute": "aspect-ratio",
  3452. "description": "The aspect ratio of the embedded media in the format of `width:height`, e.g. `16:9`, `4:3`, or `1:1`. Ratios not in\nthis format will be ignored.",
  3453. "type": "string",
  3454. "defaultValue": "'16:9'"
  3455. },
  3456. {
  3457. "name": "fit",
  3458. "description": "Determines how content will be resized to fit its container.",
  3459. "type": "'cover' | 'contain'",
  3460. "values": [
  3461. "cover",
  3462. "contain"
  3463. ],
  3464. "defaultValue": "'cover'"
  3465. }
  3466. ],
  3467. "methods": [],
  3468. "events": [],
  3469. "slots": [
  3470. {
  3471. "name": "",
  3472. "description": "The element to receive the aspect ratio. Should be a replaced element, such as `<img>`, `<iframe>`, or `<video>`."
  3473. }
  3474. ],
  3475. "cssCustomProperties": [],
  3476. "parts": [],
  3477. "dependencies": [],
  3478. "animations": []
  3479. },
  3480. {
  3481. "className": "SlSelect",
  3482. "tag": "sl-select",
  3483. "file": "src/components/select/select.ts",
  3484. "since": "2.0",
  3485. "status": "stable",
  3486. "props": [
  3487. {
  3488. "name": "clearable",
  3489. "description": "Adds a clear button when the select is populated.",
  3490. "type": "boolean",
  3491. "defaultValue": "false"
  3492. },
  3493. {
  3494. "name": "disabled",
  3495. "description": "Disables the select control.",
  3496. "type": "boolean",
  3497. "defaultValue": "false"
  3498. },
  3499. {
  3500. "name": "helpText",
  3501. "attribute": "help-text",
  3502. "description": "The select's help text. Alternatively, you can use the help-text slot.",
  3503. "type": "string"
  3504. },
  3505. {
  3506. "name": "hoist",
  3507. "description": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`.",
  3508. "type": "boolean",
  3509. "defaultValue": "false"
  3510. },
  3511. {
  3512. "name": "invalid",
  3513. "description": "This will be true when the control is in an invalid state. Validity is determined by the `required` prop.",
  3514. "type": "boolean",
  3515. "defaultValue": "false"
  3516. },
  3517. {
  3518. "name": "label",
  3519. "description": "The select's label. Alternatively, you can use the label slot.",
  3520. "type": "string"
  3521. },
  3522. {
  3523. "name": "maxTagsVisible",
  3524. "attribute": "max-tags-visible",
  3525. "description": "The maximum number of tags to show when `multiple` is true. After the maximum, \"+n\" will be shown to indicate the\nnumber of additional items that are selected. Set to -1 to remove the limit.",
  3526. "type": "number",
  3527. "defaultValue": "3"
  3528. },
  3529. {
  3530. "name": "multiple",
  3531. "description": "Enables multiselect. With this enabled, value will be an array.",
  3532. "type": "boolean",
  3533. "defaultValue": "false"
  3534. },
  3535. {
  3536. "name": "name",
  3537. "description": "The select's name.",
  3538. "type": "string",
  3539. "defaultValue": "''"
  3540. },
  3541. {
  3542. "name": "pill",
  3543. "description": "Draws a pill-style select with rounded edges.",
  3544. "type": "boolean",
  3545. "defaultValue": "false"
  3546. },
  3547. {
  3548. "name": "placeholder",
  3549. "description": "The select's placeholder text.",
  3550. "type": "string",
  3551. "defaultValue": "''"
  3552. },
  3553. {
  3554. "name": "required",
  3555. "description": "The select's required attribute.",
  3556. "type": "boolean",
  3557. "defaultValue": "false"
  3558. },
  3559. {
  3560. "name": "size",
  3561. "description": "The select's size.",
  3562. "type": "'small' | 'medium' | 'large'",
  3563. "values": [
  3564. "small",
  3565. "medium",
  3566. "large"
  3567. ],
  3568. "defaultValue": "'medium'"
  3569. },
  3570. {
  3571. "name": "value",
  3572. "description": "The value of the control. This will be a string or an array depending on `multiple`.",
  3573. "type": "string | ",
  3574. "values": [
  3575. "string"
  3576. ],
  3577. "defaultValue": "''"
  3578. }
  3579. ],
  3580. "methods": [
  3581. {
  3582. "name": "reportValidity",
  3583. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  3584. "params": []
  3585. },
  3586. {
  3587. "name": "setCustomValidity",
  3588. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  3589. "params": [
  3590. {
  3591. "name": "message",
  3592. "type": "string"
  3593. }
  3594. ]
  3595. }
  3596. ],
  3597. "events": [
  3598. {
  3599. "name": "sl-blur",
  3600. "description": "Emitted when the control loses focus.",
  3601. "details": "void"
  3602. },
  3603. {
  3604. "name": "sl-change",
  3605. "description": "Emitted when the control's value changes.",
  3606. "details": "void"
  3607. },
  3608. {
  3609. "name": "sl-clear",
  3610. "description": "Emitted when the clear button is activated.",
  3611. "details": "void"
  3612. },
  3613. {
  3614. "name": "sl-focus",
  3615. "description": "Emitted when the control gains focus.",
  3616. "details": "void"
  3617. }
  3618. ],
  3619. "slots": [
  3620. {
  3621. "name": "",
  3622. "description": "The select's options in the form of menu items."
  3623. },
  3624. {
  3625. "name": "label",
  3626. "description": "The select's label. Alternatively, you can use the label prop."
  3627. },
  3628. {
  3629. "name": "help-text",
  3630. "description": "Help text that describes how to use the select.\n"
  3631. }
  3632. ],
  3633. "cssCustomProperties": [
  3634. {
  3635. "name": "--focus-ring",
  3636. "description": "The focus ring style to use when the control receives focus, a `box-shadow` property.\n"
  3637. }
  3638. ],
  3639. "parts": [
  3640. {
  3641. "name": "base",
  3642. "description": "The component's base wrapper."
  3643. },
  3644. {
  3645. "name": "clear-button",
  3646. "description": "The input's clear button, exported from <sl-input>."
  3647. },
  3648. {
  3649. "name": "form-control",
  3650. "description": "The form control that wraps the label, input, and help text."
  3651. },
  3652. {
  3653. "name": "help-text",
  3654. "description": "The select's help text."
  3655. },
  3656. {
  3657. "name": "icon",
  3658. "description": "The select's icon."
  3659. },
  3660. {
  3661. "name": "label",
  3662. "description": "The select's label."
  3663. },
  3664. {
  3665. "name": "menu",
  3666. "description": "The select menu, a <sl-menu> element."
  3667. },
  3668. {
  3669. "name": "tag",
  3670. "description": "The multiselect option, a <sl-tag> element."
  3671. },
  3672. {
  3673. "name": "tags",
  3674. "description": "The container in which multiselect options are rendered.\n"
  3675. }
  3676. ],
  3677. "dependencies": [
  3678. "sl-dropdown",
  3679. "sl-icon",
  3680. "sl-icon-button",
  3681. "sl-menu",
  3682. "sl-tag"
  3683. ],
  3684. "animations": []
  3685. },
  3686. {
  3687. "className": "SlSkeleton",
  3688. "tag": "sl-skeleton",
  3689. "file": "src/components/skeleton/skeleton.ts",
  3690. "since": "2.0",
  3691. "status": "stable",
  3692. "props": [
  3693. {
  3694. "name": "effect",
  3695. "description": "Determines which effect the skeleton will use.",
  3696. "type": "'none' | 'pulse' | 'sheen'",
  3697. "values": [
  3698. "none",
  3699. "pulse",
  3700. "sheen"
  3701. ],
  3702. "defaultValue": "'sheen'"
  3703. }
  3704. ],
  3705. "methods": [],
  3706. "events": [],
  3707. "slots": [],
  3708. "cssCustomProperties": [
  3709. {
  3710. "name": "--border-radius",
  3711. "description": "The skeleton's border radius."
  3712. },
  3713. {
  3714. "name": "--color",
  3715. "description": "The color of the skeleton."
  3716. },
  3717. {
  3718. "name": "--sheen-color",
  3719. "description": "The sheen color when the skeleton is in its loading state.\n"
  3720. }
  3721. ],
  3722. "parts": [
  3723. {
  3724. "name": "base",
  3725. "description": "The component's base wrapper."
  3726. },
  3727. {
  3728. "name": "indicator",
  3729. "description": "The skeleton's indicator which is responsible for its color and animation.\n"
  3730. }
  3731. ],
  3732. "dependencies": [],
  3733. "animations": []
  3734. },
  3735. {
  3736. "className": "SlSpinner",
  3737. "tag": "sl-spinner",
  3738. "file": "src/components/spinner/spinner.ts",
  3739. "since": "2.0",
  3740. "status": "stable",
  3741. "props": [],
  3742. "methods": [],
  3743. "events": [],
  3744. "slots": [],
  3745. "cssCustomProperties": [
  3746. {
  3747. "name": "--track-color",
  3748. "description": "The color of the spinner's track."
  3749. },
  3750. {
  3751. "name": "--indicator-color",
  3752. "description": "The color of the spinner's indicator."
  3753. },
  3754. {
  3755. "name": "--stroke-width",
  3756. "description": "The width of the indicator.\n"
  3757. }
  3758. ],
  3759. "parts": [
  3760. {
  3761. "name": "base",
  3762. "description": "The component's base wrapper.\n"
  3763. }
  3764. ],
  3765. "dependencies": [],
  3766. "animations": []
  3767. },
  3768. {
  3769. "className": "SlSwitch",
  3770. "tag": "sl-switch",
  3771. "file": "src/components/switch/switch.ts",
  3772. "since": "2.0",
  3773. "status": "stable",
  3774. "props": [
  3775. {
  3776. "name": "checked",
  3777. "description": "Draws the switch in a checked state.",
  3778. "type": "boolean",
  3779. "defaultValue": "false"
  3780. },
  3781. {
  3782. "name": "disabled",
  3783. "description": "Disables the switch.",
  3784. "type": "boolean",
  3785. "defaultValue": "false"
  3786. },
  3787. {
  3788. "name": "invalid",
  3789. "description": "This will be true when the control is in an invalid state. Validity is determined by the `required` prop.",
  3790. "type": "boolean",
  3791. "defaultValue": "false"
  3792. },
  3793. {
  3794. "name": "name",
  3795. "description": "The switch's name attribute.",
  3796. "type": "string"
  3797. },
  3798. {
  3799. "name": "required",
  3800. "description": "Makes the switch a required field.",
  3801. "type": "boolean",
  3802. "defaultValue": "false"
  3803. },
  3804. {
  3805. "name": "value",
  3806. "description": "The switch's value attribute.",
  3807. "type": "string"
  3808. }
  3809. ],
  3810. "methods": [
  3811. {
  3812. "name": "blur",
  3813. "description": "Removes focus from the switch.",
  3814. "params": []
  3815. },
  3816. {
  3817. "name": "click",
  3818. "description": "Simulates a click on the switch.",
  3819. "params": []
  3820. },
  3821. {
  3822. "name": "focus",
  3823. "description": "Sets focus on the switch.",
  3824. "params": [
  3825. {
  3826. "name": "options",
  3827. "type": "FocusOptions",
  3828. "isOptional": true
  3829. }
  3830. ]
  3831. },
  3832. {
  3833. "name": "reportValidity",
  3834. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  3835. "params": []
  3836. },
  3837. {
  3838. "name": "setCustomValidity",
  3839. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  3840. "params": [
  3841. {
  3842. "name": "message",
  3843. "type": "string"
  3844. }
  3845. ]
  3846. }
  3847. ],
  3848. "events": [
  3849. {
  3850. "name": "sl-blur",
  3851. "description": "Emitted when the control loses focus.",
  3852. "details": "void"
  3853. },
  3854. {
  3855. "name": "sl-change",
  3856. "description": "Emitted when the control's checked state changes.",
  3857. "details": "void"
  3858. },
  3859. {
  3860. "name": "sl-focus",
  3861. "description": "Emitted when the control gains focus.",
  3862. "details": "void"
  3863. }
  3864. ],
  3865. "slots": [
  3866. {
  3867. "name": "",
  3868. "description": "The switch's label."
  3869. }
  3870. ],
  3871. "cssCustomProperties": [
  3872. {
  3873. "name": "--width",
  3874. "description": "The width of the switch."
  3875. },
  3876. {
  3877. "name": "--height",
  3878. "description": "The height of the switch."
  3879. },
  3880. {
  3881. "name": "--thumb-size",
  3882. "description": "The size of the thumb.\n"
  3883. }
  3884. ],
  3885. "parts": [
  3886. {
  3887. "name": "base",
  3888. "description": "The component's base wrapper."
  3889. },
  3890. {
  3891. "name": "control",
  3892. "description": "The switch control."
  3893. },
  3894. {
  3895. "name": "thumb",
  3896. "description": "The switch position indicator."
  3897. },
  3898. {
  3899. "name": "label",
  3900. "description": "The switch label.\n"
  3901. }
  3902. ],
  3903. "dependencies": [],
  3904. "animations": []
  3905. },
  3906. {
  3907. "className": "SlTab",
  3908. "tag": "sl-tab",
  3909. "file": "src/components/tab/tab.ts",
  3910. "since": "2.0",
  3911. "status": "stable",
  3912. "props": [
  3913. {
  3914. "name": "active",
  3915. "description": "Draws the tab in an active state.",
  3916. "type": "boolean",
  3917. "defaultValue": "false"
  3918. },
  3919. {
  3920. "name": "closable",
  3921. "description": "Makes the tab closable and shows a close icon.",
  3922. "type": "boolean",
  3923. "defaultValue": "false"
  3924. },
  3925. {
  3926. "name": "disabled",
  3927. "description": "Draws the tab in a disabled state.",
  3928. "type": "boolean",
  3929. "defaultValue": "false"
  3930. },
  3931. {
  3932. "name": "panel",
  3933. "description": "The name of the tab panel the tab will control. The panel must be located in the same tab group.",
  3934. "type": "string",
  3935. "defaultValue": "''"
  3936. }
  3937. ],
  3938. "methods": [
  3939. {
  3940. "name": "blur",
  3941. "description": "Removes focus from the tab.",
  3942. "params": []
  3943. },
  3944. {
  3945. "name": "focus",
  3946. "description": "Sets focus to the tab.",
  3947. "params": [
  3948. {
  3949. "name": "options",
  3950. "type": "FocusOptions",
  3951. "isOptional": true
  3952. }
  3953. ]
  3954. }
  3955. ],
  3956. "events": [
  3957. {
  3958. "name": "sl-close",
  3959. "description": "Emitted when the tab is closable and the close button is activated.",
  3960. "details": "void"
  3961. }
  3962. ],
  3963. "slots": [
  3964. {
  3965. "name": "",
  3966. "description": "The tab's label."
  3967. }
  3968. ],
  3969. "cssCustomProperties": [
  3970. {
  3971. "name": "--focus-ring",
  3972. "description": "The focus ring's box shadow.\n"
  3973. }
  3974. ],
  3975. "parts": [
  3976. {
  3977. "name": "base",
  3978. "description": "The component's base wrapper."
  3979. },
  3980. {
  3981. "name": "close-button",
  3982. "description": "The close button, which is the icon button's base wrapper.\n"
  3983. }
  3984. ],
  3985. "dependencies": [
  3986. "sl-icon-button"
  3987. ],
  3988. "animations": []
  3989. },
  3990. {
  3991. "className": "SlTabGroup",
  3992. "tag": "sl-tab-group",
  3993. "file": "src/components/tab-group/tab-group.ts",
  3994. "since": "2.0",
  3995. "status": "stable",
  3996. "props": [
  3997. {
  3998. "name": "activation",
  3999. "description": "When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to\nmanual, the tab will receive focus but will not show until the user presses spacebar or enter.",
  4000. "type": "'auto' | 'manual'",
  4001. "values": [
  4002. "auto",
  4003. "manual"
  4004. ],
  4005. "defaultValue": "'auto'"
  4006. },
  4007. {
  4008. "name": "noScrollControls",
  4009. "attribute": "no-scroll-controls",
  4010. "description": "Disables the scroll arrows that appear when tabs overflow.",
  4011. "type": "boolean",
  4012. "defaultValue": "false"
  4013. },
  4014. {
  4015. "name": "placement",
  4016. "description": "The placement of the tabs.",
  4017. "type": "'top' | 'end' | 'bottom' | 'start'",
  4018. "values": [
  4019. "top",
  4020. "end",
  4021. "bottom",
  4022. "start"
  4023. ],
  4024. "defaultValue": "'top'"
  4025. }
  4026. ],
  4027. "methods": [
  4028. {
  4029. "name": "show",
  4030. "description": "Shows the specified tab panel.",
  4031. "params": [
  4032. {
  4033. "name": "panel",
  4034. "type": "string"
  4035. }
  4036. ]
  4037. }
  4038. ],
  4039. "events": [
  4040. {
  4041. "name": "sl-tab-hide",
  4042. "description": "Emitted when a tab is hidden.",
  4043. "details": "{ tab: string }"
  4044. },
  4045. {
  4046. "name": "sl-tab-show",
  4047. "description": "Emitted when a tab is shown.",
  4048. "details": "{ tab: string }"
  4049. }
  4050. ],
  4051. "slots": [
  4052. {
  4053. "name": "nav",
  4054. "description": "Used for grouping tabs in the tab group."
  4055. },
  4056. {
  4057. "name": "",
  4058. "description": "Used for grouping tab panels in the tab group."
  4059. }
  4060. ],
  4061. "cssCustomProperties": [
  4062. {
  4063. "name": "--tabs-border-color",
  4064. "description": "The color of the border that separates tabs.\n"
  4065. }
  4066. ],
  4067. "parts": [
  4068. {
  4069. "name": "base",
  4070. "description": "The component's base wrapper."
  4071. },
  4072. {
  4073. "name": "nav",
  4074. "description": "The tab group navigation container."
  4075. },
  4076. {
  4077. "name": "tabs",
  4078. "description": "The container that wraps the slotted tabs."
  4079. },
  4080. {
  4081. "name": "active-tab-indicator",
  4082. "description": "An element that displays the currently selected tab. This is a child of the tabs container."
  4083. },
  4084. {
  4085. "name": "body",
  4086. "description": "The tab group body where tab panels are slotted in."
  4087. },
  4088. {
  4089. "name": "scroll-button",
  4090. "description": "The previous and next scroll buttons that appear when tabs are scrollable.\n"
  4091. }
  4092. ],
  4093. "dependencies": [
  4094. "sl-icon-button"
  4095. ],
  4096. "animations": []
  4097. },
  4098. {
  4099. "className": "SlTabPanel",
  4100. "tag": "sl-tab-panel",
  4101. "file": "src/components/tab-panel/tab-panel.ts",
  4102. "since": "2.0",
  4103. "status": "stable",
  4104. "props": [
  4105. {
  4106. "name": "active",
  4107. "description": "When true, the tab panel will be shown.",
  4108. "type": "boolean",
  4109. "defaultValue": "false"
  4110. },
  4111. {
  4112. "name": "name",
  4113. "description": "The tab panel's name.",
  4114. "type": "string",
  4115. "defaultValue": "''"
  4116. }
  4117. ],
  4118. "methods": [],
  4119. "events": [],
  4120. "slots": [
  4121. {
  4122. "name": "",
  4123. "description": "The tab panel's content."
  4124. }
  4125. ],
  4126. "cssCustomProperties": [],
  4127. "parts": [
  4128. {
  4129. "name": "base",
  4130. "description": "The component's base wrapper.\n"
  4131. }
  4132. ],
  4133. "dependencies": [],
  4134. "animations": []
  4135. },
  4136. {
  4137. "className": "SlTag",
  4138. "tag": "sl-tag",
  4139. "file": "src/components/tag/tag.ts",
  4140. "since": "2.0",
  4141. "status": "stable",
  4142. "props": [
  4143. {
  4144. "name": "clearable",
  4145. "description": "Makes the tag clearable.",
  4146. "type": "boolean",
  4147. "defaultValue": "false"
  4148. },
  4149. {
  4150. "name": "pill",
  4151. "description": "Draws a pill-style tag with rounded edges.",
  4152. "type": "boolean",
  4153. "defaultValue": "false"
  4154. },
  4155. {
  4156. "name": "size",
  4157. "description": "The tag's size.",
  4158. "type": "'small' | 'medium' | 'large'",
  4159. "values": [
  4160. "small",
  4161. "medium",
  4162. "large"
  4163. ],
  4164. "defaultValue": "'medium'"
  4165. },
  4166. {
  4167. "name": "type",
  4168. "description": "The tag's type.",
  4169. "type": "'primary' | 'success' | 'info' | 'warning' | 'danger' | 'text'",
  4170. "values": [
  4171. "primary",
  4172. "success",
  4173. "info",
  4174. "warning",
  4175. "danger",
  4176. "text"
  4177. ],
  4178. "defaultValue": "'primary'"
  4179. }
  4180. ],
  4181. "methods": [],
  4182. "events": [
  4183. {
  4184. "name": "sl-clear",
  4185. "description": "Emitted when the clear button is activated.",
  4186. "details": "void"
  4187. }
  4188. ],
  4189. "slots": [
  4190. {
  4191. "name": "",
  4192. "description": "The tag's content."
  4193. }
  4194. ],
  4195. "cssCustomProperties": [],
  4196. "parts": [
  4197. {
  4198. "name": "base",
  4199. "description": "The component's base wrapper."
  4200. },
  4201. {
  4202. "name": "content",
  4203. "description": "The tag content."
  4204. },
  4205. {
  4206. "name": "clear-button",
  4207. "description": "The clear button.\n"
  4208. }
  4209. ],
  4210. "dependencies": [
  4211. "sl-icon-button"
  4212. ],
  4213. "animations": []
  4214. },
  4215. {
  4216. "className": "SlTextarea",
  4217. "tag": "sl-textarea",
  4218. "file": "src/components/textarea/textarea.ts",
  4219. "since": "2.0",
  4220. "status": "stable",
  4221. "props": [
  4222. {
  4223. "name": "autocapitalize",
  4224. "description": "The textarea's autocaptialize attribute.",
  4225. "type": "'none' | 'off' | 'on' | 'sentences' | 'words' | 'characters'",
  4226. "values": [
  4227. "none",
  4228. "off",
  4229. "on",
  4230. "sentences",
  4231. "words",
  4232. "characters"
  4233. ]
  4234. },
  4235. {
  4236. "name": "autocomplete",
  4237. "description": "The textarea's autocomplete attribute.",
  4238. "type": "string"
  4239. },
  4240. {
  4241. "name": "autocorrect",
  4242. "description": "The textarea's autocorrect attribute.",
  4243. "type": "string"
  4244. },
  4245. {
  4246. "name": "autofocus",
  4247. "description": "The textarea's autofocus attribute.",
  4248. "type": "boolean"
  4249. },
  4250. {
  4251. "name": "disabled",
  4252. "description": "Disables the textarea.",
  4253. "type": "boolean",
  4254. "defaultValue": "false"
  4255. },
  4256. {
  4257. "name": "helpText",
  4258. "attribute": "help-text",
  4259. "description": "The textarea's help text. Alternatively, you can use the help-text slot.",
  4260. "type": "string",
  4261. "defaultValue": "''"
  4262. },
  4263. {
  4264. "name": "inputmode",
  4265. "description": "The textarea's inputmode attribute.",
  4266. "type": "'none' | 'text' | 'numeric' | 'decimal' | 'email' | 'search' | 'tel' | 'url'",
  4267. "values": [
  4268. "none",
  4269. "text",
  4270. "numeric",
  4271. "decimal",
  4272. "email",
  4273. "search",
  4274. "tel",
  4275. "url"
  4276. ]
  4277. },
  4278. {
  4279. "name": "invalid",
  4280. "description": "This will be true when the control is in an invalid state. Validity is determined by props such as `type`,\n`required`, `minlength`, and `maxlength` using the browser's constraint validation API.",
  4281. "type": "boolean",
  4282. "defaultValue": "false"
  4283. },
  4284. {
  4285. "name": "label",
  4286. "description": "The textarea's label. Alternatively, you can use the label slot.",
  4287. "type": "string"
  4288. },
  4289. {
  4290. "name": "maxlength",
  4291. "description": "The maximum length of input that will be considered valid.",
  4292. "type": "number"
  4293. },
  4294. {
  4295. "name": "minlength",
  4296. "description": "The minimum length of input that will be considered valid.",
  4297. "type": "number"
  4298. },
  4299. {
  4300. "name": "name",
  4301. "description": "The textarea's name attribute.",
  4302. "type": "string"
  4303. },
  4304. {
  4305. "name": "pattern",
  4306. "description": "A pattern to validate input against.",
  4307. "type": "string"
  4308. },
  4309. {
  4310. "name": "placeholder",
  4311. "description": "The textarea's placeholder text.",
  4312. "type": "string"
  4313. },
  4314. {
  4315. "name": "readonly",
  4316. "description": "Makes the textarea readonly.",
  4317. "type": "boolean",
  4318. "defaultValue": "false"
  4319. },
  4320. {
  4321. "name": "required",
  4322. "description": "Makes the textarea a required field.",
  4323. "type": "boolean",
  4324. "defaultValue": "false"
  4325. },
  4326. {
  4327. "name": "resize",
  4328. "description": "Controls how the textarea can be resized.",
  4329. "type": "'none' | 'auto' | 'vertical'",
  4330. "values": [
  4331. "none",
  4332. "auto",
  4333. "vertical"
  4334. ],
  4335. "defaultValue": "'vertical'"
  4336. },
  4337. {
  4338. "name": "rows",
  4339. "description": "The number of rows to display by default.",
  4340. "type": "number",
  4341. "defaultValue": "4"
  4342. },
  4343. {
  4344. "name": "size",
  4345. "description": "The textarea's size.",
  4346. "type": "'small' | 'medium' | 'large'",
  4347. "values": [
  4348. "small",
  4349. "medium",
  4350. "large"
  4351. ],
  4352. "defaultValue": "'medium'"
  4353. },
  4354. {
  4355. "name": "spellcheck",
  4356. "description": "Enables spell checking on the textarea.",
  4357. "type": "boolean"
  4358. },
  4359. {
  4360. "name": "value",
  4361. "description": "The textarea's value attribute.",
  4362. "type": "string",
  4363. "defaultValue": "''"
  4364. }
  4365. ],
  4366. "methods": [
  4367. {
  4368. "name": "blur",
  4369. "description": "Removes focus from the textarea.",
  4370. "params": []
  4371. },
  4372. {
  4373. "name": "focus",
  4374. "description": "Sets focus on the textarea.",
  4375. "params": [
  4376. {
  4377. "name": "options",
  4378. "type": "FocusOptions",
  4379. "isOptional": true
  4380. }
  4381. ]
  4382. },
  4383. {
  4384. "name": "reportValidity",
  4385. "description": "Checks for validity and shows the browser's validation message if the control is invalid.",
  4386. "params": []
  4387. },
  4388. {
  4389. "name": "scrollPosition",
  4390. "description": "Gets or sets the textarea's scroll position.",
  4391. "params": [
  4392. {
  4393. "name": "position",
  4394. "type": "{ left?: number, top?: number }",
  4395. "isOptional": true
  4396. }
  4397. ]
  4398. },
  4399. {
  4400. "name": "select",
  4401. "description": "Selects all the text in the textarea.",
  4402. "params": []
  4403. },
  4404. {
  4405. "name": "setCustomValidity",
  4406. "description": "Sets a custom validation message. If `message` is not empty, the field will be considered invalid.",
  4407. "params": [
  4408. {
  4409. "name": "message",
  4410. "type": "string"
  4411. }
  4412. ]
  4413. },
  4414. {
  4415. "name": "setRangeText",
  4416. "description": "Replaces a range of text with a new string.",
  4417. "params": [
  4418. {
  4419. "name": "replacement",
  4420. "type": "string"
  4421. },
  4422. {
  4423. "name": "start",
  4424. "type": "number"
  4425. },
  4426. {
  4427. "name": "end",
  4428. "type": "number"
  4429. },
  4430. {
  4431. "name": "selectMode",
  4432. "type": "'end' | 'start' | 'select' | 'preserve'",
  4433. "values": [
  4434. "end",
  4435. "start",
  4436. "select",
  4437. "preserve"
  4438. ],
  4439. "defaultValue": "'preserve'"
  4440. }
  4441. ]
  4442. },
  4443. {
  4444. "name": "setSelectionRange",
  4445. "description": "Sets the start and end positions of the text selection (0-based).",
  4446. "params": [
  4447. {
  4448. "name": "selectionStart",
  4449. "type": "number"
  4450. },
  4451. {
  4452. "name": "selectionEnd",
  4453. "type": "number"
  4454. },
  4455. {
  4456. "name": "selectionDirection",
  4457. "type": "'none' | 'forward' | 'backward'",
  4458. "values": [
  4459. "none",
  4460. "forward",
  4461. "backward"
  4462. ],
  4463. "defaultValue": "'none'"
  4464. }
  4465. ]
  4466. }
  4467. ],
  4468. "events": [
  4469. {
  4470. "name": "sl-blur",
  4471. "description": "Emitted when the control loses focus.",
  4472. "details": "void"
  4473. },
  4474. {
  4475. "name": "sl-change",
  4476. "description": "Emitted when the control's value changes.",
  4477. "details": "void"
  4478. },
  4479. {
  4480. "name": "sl-focus",
  4481. "description": "Emitted when the control gains focus.",
  4482. "details": "void"
  4483. },
  4484. {
  4485. "name": "sl-input",
  4486. "description": "Emitted when the control receives input.",
  4487. "details": "void"
  4488. }
  4489. ],
  4490. "slots": [
  4491. {
  4492. "name": "label",
  4493. "description": "The textarea's label. Alternatively, you can use the label prop."
  4494. },
  4495. {
  4496. "name": "help-text",
  4497. "description": "Help text that describes how to use the input.\n"
  4498. }
  4499. ],
  4500. "cssCustomProperties": [],
  4501. "parts": [
  4502. {
  4503. "name": "base",
  4504. "description": "The component's base wrapper."
  4505. },
  4506. {
  4507. "name": "form-control",
  4508. "description": "The form control that wraps the label, textarea, and help text."
  4509. },
  4510. {
  4511. "name": "label",
  4512. "description": "The textarea label."
  4513. },
  4514. {
  4515. "name": "textarea",
  4516. "description": "The textarea control."
  4517. },
  4518. {
  4519. "name": "help-text",
  4520. "description": "The textarea help text.\n"
  4521. }
  4522. ],
  4523. "dependencies": [],
  4524. "animations": []
  4525. },
  4526. {
  4527. "className": "SlTooltip",
  4528. "tag": "sl-tooltip",
  4529. "file": "src/components/tooltip/tooltip.ts",
  4530. "since": "2.0",
  4531. "status": "stable",
  4532. "props": [
  4533. {
  4534. "name": "content",
  4535. "description": "The tooltip's content. Alternatively, you can use the content slot.",
  4536. "type": "string",
  4537. "defaultValue": "''"
  4538. },
  4539. {
  4540. "name": "disabled",
  4541. "description": "Disables the tooltip so it won't show when triggered.",
  4542. "type": "boolean",
  4543. "defaultValue": "false"
  4544. },
  4545. {
  4546. "name": "distance",
  4547. "description": "The distance in pixels from which to offset the tooltip away from its target.",
  4548. "type": "number",
  4549. "defaultValue": "10"
  4550. },
  4551. {
  4552. "name": "open",
  4553. "description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
  4554. "type": "boolean",
  4555. "defaultValue": "false"
  4556. },
  4557. {
  4558. "name": "placement",
  4559. "description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
  4560. "type": "'top' | 'bottom' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end'",
  4561. "values": [
  4562. "top",
  4563. "bottom",
  4564. "top-start",
  4565. "top-end",
  4566. "bottom-start",
  4567. "bottom-end",
  4568. "right",
  4569. "right-start",
  4570. "right-end",
  4571. "left",
  4572. "left-start",
  4573. "left-end"
  4574. ],
  4575. "defaultValue": "'top'"
  4576. },
  4577. {
  4578. "name": "skidding",
  4579. "description": "The distance in pixels from which to offset the tooltip along its target.",
  4580. "type": "number",
  4581. "defaultValue": "0"
  4582. },
  4583. {
  4584. "name": "trigger",
  4585. "description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.",
  4586. "type": "string",
  4587. "defaultValue": "'hover focus'"
  4588. }
  4589. ],
  4590. "methods": [
  4591. {
  4592. "name": "hide",
  4593. "description": "Hides the tooltip",
  4594. "params": []
  4595. },
  4596. {
  4597. "name": "show",
  4598. "description": "Shows the tooltip.",
  4599. "params": []
  4600. }
  4601. ],
  4602. "events": [
  4603. {
  4604. "name": "sl-after-hide",
  4605. "description": "Emitted after the tooltip has hidden and all transitions are complete.",
  4606. "details": "void"
  4607. },
  4608. {
  4609. "name": "sl-after-show",
  4610. "description": "Emitted after the tooltip has shown and all transitions are complete.",
  4611. "details": "void"
  4612. },
  4613. {
  4614. "name": "sl-hide",
  4615. "description": "Emitted when the tooltip begins to hide.",
  4616. "details": "void"
  4617. },
  4618. {
  4619. "name": "sl-show",
  4620. "description": "Emitted when the tooltip begins to show.",
  4621. "details": "void"
  4622. }
  4623. ],
  4624. "slots": [
  4625. {
  4626. "name": "",
  4627. "description": "The tooltip's target element. Only the first element will be used as the target."
  4628. },
  4629. {
  4630. "name": "content",
  4631. "description": "The tooltip's content. Alternatively, you can use the content prop.\n"
  4632. }
  4633. ],
  4634. "cssCustomProperties": [
  4635. {
  4636. "name": "--max-width",
  4637. "description": "The maximum width of the tooltip."
  4638. },
  4639. {
  4640. "name": "--hide-delay",
  4641. "description": "The amount of time to wait before hiding the tooltip when hovering."
  4642. },
  4643. {
  4644. "name": "--show-delay",
  4645. "description": "The amount of time to wait before showing the tooltip when hovering.\n"
  4646. }
  4647. ],
  4648. "parts": [
  4649. {
  4650. "name": "base",
  4651. "description": "The component's base wrapper.\n"
  4652. }
  4653. ],
  4654. "dependencies": [],
  4655. "animations": [
  4656. {
  4657. "name": "tooltip.show",
  4658. "description": "The animation to use when showing the tooltip."
  4659. },
  4660. {
  4661. "name": "tooltip.hide",
  4662. "description": "The animation to use when hiding the tooltip.\n"
  4663. }
  4664. ]
  4665. }
  4666. ]
  4667. }