https://touying-typ.github.io/assets/js/8788e5d4.0e997fc2.js

1"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[5805],{72984:(e,i,s)=>{s.r(i),s.d(i,{assets:()=>o,contentTitle:()=>c,default:()=>u,frontMatter:()=>r,metadata:()=>l,toc:()=>d});var n=s(85893),t=s(11151);const r={sidebar_position:39,description:"Check if a subslide index is visible given a visibility specification.",toc_max_heading_level:2},c="check-visible",l={id:"reference/utils/check-visible",title:"check-visible",description:"Check if a subslide index is visible given a visibility specification.",source:"@site/docs/reference/utils/check-visible.mdx",sourceDirName:"reference/utils",slug:"/reference/utils/check-visible",permalink:"/docs/reference/utils/check-visible",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:39,frontMatter:{sidebar_position:39,description:"Check if a subslide index is visible given a visibility specification.",toc_max_heading_level:2},sidebar:"tutorialSidebar",previous:{title:"alert",permalink:"/docs/reference/utils/alert"},next:{title:"resolve-waypoints",permalink:"/docs/reference/utils/resolve-waypoints"}},o={},d=[{value:"idx : <TypeLink></TypeLink>",id:"idx",level:3},{value:"visible-subslides : <TypeLink></TypeLink> | <TypeLink></TypeLink> | <TypeLink></TypeLink>",id:"visible-subslides",level:3}];function a(e){const i={a:"a",code:"code",h1:"h1",h3:"h3",p:"p",strong:"strong",...(0,t.a)(),...e.components},{Param:s,Parameters:r,Signature:c,SignatureName:l,SignatureParam:o,SourceLink:d,TypeLink:a}=i;return s||h("Param",!0),r||h("Parameters",!0),c||h("Signature",!0),l||h("SignatureName",!0),o||h("SignatureParam",!0),d||h("SourceLink",!0),a||h("TypeLink",!0),(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(i.h1,{id:"check-visible",children:"check-visible"}),"\n",(0,n.jsx)(c,{children:(0,n.jsxs)("code",{children:[(0,n.jsx)(l,{children:"check-visible"}),"(",(0,n.jsxs)(o,{children:[(0,n.jsx)(i.a,{href:"#idx",children:"idx"}),", "]}),(0,n.jsx)(o,{children:(0,n.jsx)(i.a,{href:"#visible-subslides",children:"visible-subslides"})}),")",(0,n.jsx)(d,{href:"https://github.com/touying-typ/touying/blob/main/src/utils.typ#L1690"})]})}),"\n",(0,n.jsx)(i.p,{children:"Check if a subslide index is visible given a visibility specification."}),"\n",(0,n.jsxs)(i.p,{children:["Example: ",(0,n.jsx)(i.code,{children:'check-visible(3, "2-")'})," returns ",(0,n.jsx)(i.code,{children:"true"})]}),"\n",(0,n.jsxs)(r,{children:[(0,n.jsxs)(i.h3,{id:"idx",children:["idx : ",(0,n.jsx)(a,{type:"int"})]}),(0,n.jsx)(s,{children:(0,n.jsx)(i.p,{children:"The current subslide index."})}),(0,n.jsxs)(i.h3,{id:"visible-subslides",children:["visible-subslides : ",(0,n.jsx)(a,{type:"int"})," | ",(0,n.jsx)(a,{type:"array"})," | ",(0,n.jsx)(a,{type:"str"})]}),(0,n.jsx)(s,{children:(0,n.jsxs)(i.p,{children:["Specifies which subslides are visible. Supported formats: - A single integer, e.g. ",(0,n.jsx)(i.code,{children:"3"})," \u2014 only subslide 3. - An array, e.g. ",(0,n.jsx)(i.code,{children:"(1, 2, 4)"})," \u2014 equivalent to ",(0,n.jsx)(i.code,{children:'"1, 2, 4"'}),". - A string with ranges, e.g. ",(0,n.jsx)(i.code,{children:'"-2, 4, 6-8, 10-"'})," \u2014 subslides 1, 2, 4, 6, 7, 8, 10, and all after 10."]})})]}),"\n",(0,n.jsxs)(i.p,{children:[(0,n.jsx)(i.strong,{children:"Returns:"})," ",(0,n.jsx)(a,{type:"bool"})]})]})}function u(e={}){const{wrapper:i}={...(0,t.a)(),...e.components};return i?(0,n.jsx)(i,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}function h(e,i){throw new Error("Expected "+(i?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},11151:(e,i,s)=>{s.d(i,{Z:()=>l,a:()=>c});var n=s(67294);const t={},r=n.createContext(t);function c(e){const i=n.useContext(r);return n.useMemo((function(){return"function"==typeof e?e(i):{...i,...e}}),[i,e])}function l(e){let i;return i=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:c(e.components),n.createElement(r.Provider,{value:i},e.children)}}}]);