[{"data":1,"prerenderedAt":891},["ShallowReactive",2],{"/api/concepts/text-tokens":3,"/api/concepts/text-tokens-surround":886},{"id":4,"title":5,"body":6,"description":877,"extension":878,"links":879,"meta":880,"navigation":881,"path":882,"seo":883,"stem":884,"__hash__":885},"docs/api/2.concepts/text-tokens.md","Text tokens",{"type":7,"value":8,"toc":867},"minimark",[9,16,64,67,72,79,143,149,301,310,315,384,394,461,469,514,556,560,576,841,852,856,864],[10,11,12,15],"p",{},[13,14,5],"strong",{}," are the inline pieces that make up formatted text in Capacities. They appear in two places in the API:",[17,18,19,40],"ul",{},[20,21,22,23,29,30,33,34,39],"li",{},"Inside ",[13,24,25],{},[26,27,28],"code",{},"TextBlock"," blocks — the ",[26,31,32],{},"tokens"," array on each text block (see ",[35,36,38],"a",{"href":37},"/api/concepts/blocks","Blocks",")",[20,41,42,43,48,49,52,53,59,60,39],{},"On ",[13,44,45],{},[26,46,47],{},"richText"," properties — the ",[26,50,51],{},"richText.value"," array on ",[35,54,56],{"href":55},"/api/reference",[26,57,58],{},"GET /object"," (see ",[35,61,63],{"href":62},"/api/concepts/properties","Properties",[10,65,66],{},"Both use the same token types and shapes.",[68,69,71],"h2",{"id":70},"token-types","Token types",[10,73,74,75,78],{},"Each token has a ",[26,76,77],{},"type"," field. The payload fields depend on the type:",[80,81,82,96],"table",{},[83,84,85],"thead",{},[86,87,88,93],"tr",{},[89,90,91],"th",{},[26,92,77],{},[89,94,95],{},"Purpose",[97,98,99,110,120,133],"tbody",{},[86,100,101,107],{},[102,103,104],"td",{},[26,105,106],{},"TextToken",[102,108,109],{},"Plain text with optional character styling",[86,111,112,117],{},[102,113,114],{},[26,115,116],{},"LinkToken",[102,118,119],{},"Clickable text — external URL or link to another object",[86,121,122,127],{},[102,123,124],{},[26,125,126],{},"MathToken",[102,128,129,130,39],{},"Inline math (LaTeX in ",[26,131,132],{},"text",[86,134,135,140],{},[102,136,137],{},[26,138,139],{},"CodeToken",[102,141,142],{},"Inline code span",[144,145,147],"h3",{"id":146},"texttoken",[26,148,106],{},[150,151,156],"pre",{"className":152,"code":153,"language":154,"meta":155,"style":155},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"type\": \"TextToken\",\n  \"text\": \"Hello \",\n  \"style\": {\n    \"bold\": true,\n    \"italic\": false,\n    \"strikethrough\": false,\n    \"underline\": false\n  }\n}\n","json","",[26,157,158,167,193,213,228,245,260,274,289,295],{"__ignoreMap":155},[159,160,163],"span",{"class":161,"line":162},"line",1,[159,164,166],{"class":165},"sMK4o","{\n",[159,168,170,173,176,179,182,185,188,190],{"class":161,"line":169},2,[159,171,172],{"class":165},"  \"",[159,174,77],{"class":175},"spNyl",[159,177,178],{"class":165},"\"",[159,180,181],{"class":165},":",[159,183,184],{"class":165}," \"",[159,186,106],{"class":187},"sfazB",[159,189,178],{"class":165},[159,191,192],{"class":165},",\n",[159,194,196,198,200,202,204,206,209,211],{"class":161,"line":195},3,[159,197,172],{"class":165},[159,199,132],{"class":175},[159,201,178],{"class":165},[159,203,181],{"class":165},[159,205,184],{"class":165},[159,207,208],{"class":187},"Hello ",[159,210,178],{"class":165},[159,212,192],{"class":165},[159,214,216,218,221,223,225],{"class":161,"line":215},4,[159,217,172],{"class":165},[159,219,220],{"class":175},"style",[159,222,178],{"class":165},[159,224,181],{"class":165},[159,226,227],{"class":165}," {\n",[159,229,231,234,238,240,242],{"class":161,"line":230},5,[159,232,233],{"class":165},"    \"",[159,235,237],{"class":236},"sBMFI","bold",[159,239,178],{"class":165},[159,241,181],{"class":165},[159,243,244],{"class":165}," true,\n",[159,246,248,250,253,255,257],{"class":161,"line":247},6,[159,249,233],{"class":165},[159,251,252],{"class":236},"italic",[159,254,178],{"class":165},[159,256,181],{"class":165},[159,258,259],{"class":165}," false,\n",[159,261,263,265,268,270,272],{"class":161,"line":262},7,[159,264,233],{"class":165},[159,266,267],{"class":236},"strikethrough",[159,269,178],{"class":165},[159,271,181],{"class":165},[159,273,259],{"class":165},[159,275,277,279,282,284,286],{"class":161,"line":276},8,[159,278,233],{"class":165},[159,280,281],{"class":236},"underline",[159,283,178],{"class":165},[159,285,181],{"class":165},[159,287,288],{"class":165}," false\n",[159,290,292],{"class":161,"line":291},9,[159,293,294],{"class":165},"  }\n",[159,296,298],{"class":161,"line":297},10,[159,299,300],{"class":165},"}\n",[10,302,303,305,306,309],{},[26,304,220],{}," fields are optional booleans. You may also set ",[26,307,308],{},"color"," to a theme color key when the app uses colored text.",[144,311,313],{"id":312},"linktoken",[26,314,116],{},[150,316,318],{"className":152,"code":317,"language":154,"meta":155,"style":155},"{\n  \"type\": \"LinkToken\",\n  \"text\": \"Capacities\",\n  \"url\": \"https://capacities.io\"\n}\n",[26,319,320,324,342,361,380],{"__ignoreMap":155},[159,321,322],{"class":161,"line":162},[159,323,166],{"class":165},[159,325,326,328,330,332,334,336,338,340],{"class":161,"line":169},[159,327,172],{"class":165},[159,329,77],{"class":175},[159,331,178],{"class":165},[159,333,181],{"class":165},[159,335,184],{"class":165},[159,337,116],{"class":187},[159,339,178],{"class":165},[159,341,192],{"class":165},[159,343,344,346,348,350,352,354,357,359],{"class":161,"line":195},[159,345,172],{"class":165},[159,347,132],{"class":175},[159,349,178],{"class":165},[159,351,181],{"class":165},[159,353,184],{"class":165},[159,355,356],{"class":187},"Capacities",[159,358,178],{"class":165},[159,360,192],{"class":165},[159,362,363,365,368,370,372,374,377],{"class":161,"line":215},[159,364,172],{"class":165},[159,366,367],{"class":175},"url",[159,369,178],{"class":165},[159,371,181],{"class":165},[159,373,184],{"class":165},[159,375,376],{"class":187},"https://capacities.io",[159,378,379],{"class":165},"\"\n",[159,381,382],{"class":161,"line":230},[159,383,300],{"class":165},[10,385,386,387,390,391,393],{},"To link to an object in your space, set ",[26,388,389],{},"entityId"," to that object's id (and usually omit ",[26,392,367],{},"):",[150,395,397],{"className":152,"code":396,"language":154,"meta":155,"style":155},"{\n  \"type\": \"LinkToken\",\n  \"text\": \"My page\",\n  \"entityId\": \"7d2e7f8a-4c3b-4e1d-9f0a-123456789abc\"\n}\n",[26,398,399,403,421,440,457],{"__ignoreMap":155},[159,400,401],{"class":161,"line":162},[159,402,166],{"class":165},[159,404,405,407,409,411,413,415,417,419],{"class":161,"line":169},[159,406,172],{"class":165},[159,408,77],{"class":175},[159,410,178],{"class":165},[159,412,181],{"class":165},[159,414,184],{"class":165},[159,416,116],{"class":187},[159,418,178],{"class":165},[159,420,192],{"class":165},[159,422,423,425,427,429,431,433,436,438],{"class":161,"line":195},[159,424,172],{"class":165},[159,426,132],{"class":175},[159,428,178],{"class":165},[159,430,181],{"class":165},[159,432,184],{"class":165},[159,434,435],{"class":187},"My page",[159,437,178],{"class":165},[159,439,192],{"class":165},[159,441,442,444,446,448,450,452,455],{"class":161,"line":215},[159,443,172],{"class":165},[159,445,389],{"class":175},[159,447,178],{"class":165},[159,449,181],{"class":165},[159,451,184],{"class":165},[159,453,454],{"class":187},"7d2e7f8a-4c3b-4e1d-9f0a-123456789abc",[159,456,379],{"class":165},[159,458,459],{"class":161,"line":230},[159,460,300],{"class":165},[144,462,464,466,467],{"id":463},"mathtoken-and-codetoken",[26,465,126],{}," and ",[26,468,139],{},[150,470,472],{"className":152,"code":471,"language":154,"meta":155,"style":155},"{ \"type\": \"MathToken\", \"text\": \"E = mc^2\" }\n",[26,473,474],{"__ignoreMap":155},[159,475,476,479,481,483,485,487,489,491,493,496,498,500,502,504,506,509,511],{"class":161,"line":162},[159,477,478],{"class":165},"{",[159,480,184],{"class":165},[159,482,77],{"class":175},[159,484,178],{"class":165},[159,486,181],{"class":165},[159,488,184],{"class":165},[159,490,126],{"class":187},[159,492,178],{"class":165},[159,494,495],{"class":165},",",[159,497,184],{"class":165},[159,499,132],{"class":175},[159,501,178],{"class":165},[159,503,181],{"class":165},[159,505,184],{"class":165},[159,507,508],{"class":187},"E = mc^2",[159,510,178],{"class":165},[159,512,513],{"class":165}," }\n",[150,515,517],{"className":152,"code":516,"language":154,"meta":155,"style":155},"{ \"type\": \"CodeToken\", \"text\": \"npm install\" }\n",[26,518,519],{"__ignoreMap":155},[159,520,521,523,525,527,529,531,533,535,537,539,541,543,545,547,549,552,554],{"class":161,"line":162},[159,522,478],{"class":165},[159,524,184],{"class":165},[159,526,77],{"class":175},[159,528,178],{"class":165},[159,530,181],{"class":165},[159,532,184],{"class":165},[159,534,139],{"class":187},[159,536,178],{"class":165},[159,538,495],{"class":165},[159,540,184],{"class":165},[159,542,132],{"class":175},[159,544,178],{"class":165},[159,546,181],{"class":165},[159,548,184],{"class":165},[159,550,551],{"class":187},"npm install",[159,553,178],{"class":165},[159,555,513],{"class":165},[68,557,559],{"id":558},"building-a-line-of-text","Building a line of text",[10,561,562,563,565,566,568,569,572,573,575],{},"A ",[26,564,28],{}," (or ",[26,567,47],{}," property) is a ",[13,570,571],{},"sequence of tokens"," — like runs in a rich-text editor. Adjacent ",[26,574,106],{}," spans with different styles sit next to each other:",[150,577,579],{"className":152,"code":578,"language":154,"meta":155,"style":155},"{\n  \"type\": \"TextBlock\",\n  \"tokens\": [\n    { \"type\": \"TextToken\", \"text\": \"Read the \", \"style\": {} },\n    { \"type\": \"LinkToken\", \"text\": \"docs\", \"url\": \"https://docs.capacities.io\" },\n    { \"type\": \"TextToken\", \"text\": \" for details.\", \"style\": {} }\n  ],\n  \"blocks\": [],\n  \"hierarchy\": { \"key\": \"Base\", \"val\": 0 }\n}\n",[26,580,581,585,603,616,668,722,771,776,790,837],{"__ignoreMap":155},[159,582,583],{"class":161,"line":162},[159,584,166],{"class":165},[159,586,587,589,591,593,595,597,599,601],{"class":161,"line":169},[159,588,172],{"class":165},[159,590,77],{"class":175},[159,592,178],{"class":165},[159,594,181],{"class":165},[159,596,184],{"class":165},[159,598,28],{"class":187},[159,600,178],{"class":165},[159,602,192],{"class":165},[159,604,605,607,609,611,613],{"class":161,"line":195},[159,606,172],{"class":165},[159,608,32],{"class":175},[159,610,178],{"class":165},[159,612,181],{"class":165},[159,614,615],{"class":165}," [\n",[159,617,618,621,623,625,627,629,631,633,635,637,639,641,643,645,647,650,652,654,656,658,660,662,665],{"class":161,"line":215},[159,619,620],{"class":165},"    {",[159,622,184],{"class":165},[159,624,77],{"class":236},[159,626,178],{"class":165},[159,628,181],{"class":165},[159,630,184],{"class":165},[159,632,106],{"class":187},[159,634,178],{"class":165},[159,636,495],{"class":165},[159,638,184],{"class":165},[159,640,132],{"class":236},[159,642,178],{"class":165},[159,644,181],{"class":165},[159,646,184],{"class":165},[159,648,649],{"class":187},"Read the ",[159,651,178],{"class":165},[159,653,495],{"class":165},[159,655,184],{"class":165},[159,657,220],{"class":236},[159,659,178],{"class":165},[159,661,181],{"class":165},[159,663,664],{"class":165}," {}",[159,666,667],{"class":165}," },\n",[159,669,670,672,674,676,678,680,682,684,686,688,690,692,694,696,698,701,703,705,707,709,711,713,715,718,720],{"class":161,"line":230},[159,671,620],{"class":165},[159,673,184],{"class":165},[159,675,77],{"class":236},[159,677,178],{"class":165},[159,679,181],{"class":165},[159,681,184],{"class":165},[159,683,116],{"class":187},[159,685,178],{"class":165},[159,687,495],{"class":165},[159,689,184],{"class":165},[159,691,132],{"class":236},[159,693,178],{"class":165},[159,695,181],{"class":165},[159,697,184],{"class":165},[159,699,700],{"class":187},"docs",[159,702,178],{"class":165},[159,704,495],{"class":165},[159,706,184],{"class":165},[159,708,367],{"class":236},[159,710,178],{"class":165},[159,712,181],{"class":165},[159,714,184],{"class":165},[159,716,717],{"class":187},"https://docs.capacities.io",[159,719,178],{"class":165},[159,721,667],{"class":165},[159,723,724,726,728,730,732,734,736,738,740,742,744,746,748,750,752,755,757,759,761,763,765,767,769],{"class":161,"line":247},[159,725,620],{"class":165},[159,727,184],{"class":165},[159,729,77],{"class":236},[159,731,178],{"class":165},[159,733,181],{"class":165},[159,735,184],{"class":165},[159,737,106],{"class":187},[159,739,178],{"class":165},[159,741,495],{"class":165},[159,743,184],{"class":165},[159,745,132],{"class":236},[159,747,178],{"class":165},[159,749,181],{"class":165},[159,751,184],{"class":165},[159,753,754],{"class":187}," for details.",[159,756,178],{"class":165},[159,758,495],{"class":165},[159,760,184],{"class":165},[159,762,220],{"class":236},[159,764,178],{"class":165},[159,766,181],{"class":165},[159,768,664],{"class":165},[159,770,513],{"class":165},[159,772,773],{"class":161,"line":262},[159,774,775],{"class":165},"  ],\n",[159,777,778,780,783,785,787],{"class":161,"line":276},[159,779,172],{"class":165},[159,781,782],{"class":175},"blocks",[159,784,178],{"class":165},[159,786,181],{"class":165},[159,788,789],{"class":165}," [],\n",[159,791,792,794,797,799,801,804,806,809,811,813,815,818,820,822,824,827,829,831,835],{"class":161,"line":291},[159,793,172],{"class":165},[159,795,796],{"class":175},"hierarchy",[159,798,178],{"class":165},[159,800,181],{"class":165},[159,802,803],{"class":165}," {",[159,805,184],{"class":165},[159,807,808],{"class":236},"key",[159,810,178],{"class":165},[159,812,181],{"class":165},[159,814,184],{"class":165},[159,816,817],{"class":187},"Base",[159,819,178],{"class":165},[159,821,495],{"class":165},[159,823,184],{"class":165},[159,825,826],{"class":236},"val",[159,828,178],{"class":165},[159,830,181],{"class":165},[159,832,834],{"class":833},"sbssI"," 0",[159,836,513],{"class":165},[159,838,839],{"class":161,"line":297},[159,840,300],{"class":165},[10,842,843,844,847,848,851],{},"When ",[13,845,846],{},"writing"," blocks, you can omit ",[26,849,850],{},"id"," on the block; the server assigns ids. Tokens do not have their own ids — order in the array is the order on the page.",[68,853,855],{"id":854},"markdown-alternative","Markdown alternative",[10,857,858,859,863],{},"If you do not want to assemble tokens by hand, use the ",[35,860,862],{"href":861},"/api/concepts/markdown","Markdown"," routes to create or append content; the server converts Markdown into blocks and tokens for you.",[220,865,866],{},"html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}",{"title":155,"searchDepth":162,"depth":169,"links":868},[869,875,876],{"id":70,"depth":169,"text":71,"children":870},[871,872,873],{"id":146,"depth":195,"text":106},{"id":312,"depth":195,"text":116},{"id":463,"depth":195,"text":874},"MathToken and CodeToken",{"id":558,"depth":169,"text":559},{"id":854,"depth":169,"text":855},"Inline text tokens inside TextBlock content and richText properties.","md",null,{},true,"/api/concepts/text-tokens",{"title":5,"description":877},"api/2.concepts/text-tokens","8GhDHlPxOXMspg6Hf4abJ4FxLKFASBbUnqzDd0LpDgQ",[887,879],{"title":888,"path":889,"stem":890,"children":-1},"Structures","/api/concepts/structures","api/2.concepts/structures",1781012286319]