Star

MIT License
Copyright © 2020
CONNECT-platform

linkTabs

You can use Tabs and Tab components in conjuction for tabbed content:

1> :Tabs

2> > :Tab title=First tab

3> > <!--> This whitespace after first line is important -->

4> > **The standard Lorem Ipsum passage, used since the 1500s**

5> >

6> > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut

7> > labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris

8> > nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate

9> > velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,

10> > sunt in culpa qui officia deserunt mollit anim id est laborum.

11> <!--> This white space between tabs is important -->

12> > :Tab title=Second tab

13> >

14> > **Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC**

15> >

16> > Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium,

17> > totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta

18> > sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia

19> > consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem

20> > ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut

21> > labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem

22> > ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit

23> > qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo

24> > voluptas nulla pariatur?

The standard Lorem Ipsum passage, used since the 1500s

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?


linkIcons in Tab Title

You can uses the icon property to include an icon the title of a tab as well:

1> :Tabs

2> > :Tab title=First tab, icon=cloud

3> >

4> > **The standard Lorem Ipsum passage, used since the 1500s**

5> >

6> > Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut

7> > labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris

8> > nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate

9> > velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident,

10> > sunt in culpa qui officia deserunt mollit anim id est laborum.

11>

12> > :Tab title=Second tab, icon=settings

13> >

14> > **Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC**

15> >

16> > Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium,

17> > totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta

18> > sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia

19> > consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem

20> > ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut

21> > labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem

22> > ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit

23> > qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo

24> > voluptas nulla pariatur?

The standard Lorem Ipsum passage, used since the 1500s

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

By default, the Material Icons icon-font is used. You can of-course override that and use your own custom icon-font via .codedoc/config.ts.

Learn More about Custom Icon Font

linkReferencing Tabs in Code

You can reference another tab from a code snippet within one tab:

1> :Tabs

2> > :Tab title=Component Code

3> >

4> > ```tsx | index.tsx

5> > import { CompStyles } from './styles' // @see tab:Styling Code

6> >

7> > export function Comp() {

8> > ...

9> > }

10> > ```

11>

12> > :Tab title=Styling Code

13> > ```tsx | style.ts

14> > export const CompStyle = { ... }

15> > ```

index.ts
1import { CompStyles } from './styles' // @see tab:Styling Code

2

3export function Comp() {

4 ...

5}

style.ts
1export const CompStyle = { ... }


linkReferencing via Tab IDs

In case the title of a tab is too long, you can also give it an id and use that id to reference it from code snippet in another tab:

1> :Tabs

2> > :Tab title=Component Code

3> >

4> > ```tsx | index.tsx

5> > import { CompStyles } from './styles' // @see [Styling code](tab:styling)

6> >

7> > export function Comp() {

8> > ...

9> > }

10> > ```

11>

12> > :Tab title=Styling Code, id=styling

13> > ```tsx | style.ts

14> > export const CompStyle = { ... }

15> > ```

index.tsx
1import { CompStyles } from './styles' // @see [Styling code](tab:styling)

2

3export function Comp() {

4 ...

5}

style.ts
1export const CompStyle = { ... }

info IMPORTANT

If you specify id property of a tab, then all references MUST use id to link to the tab.

Basically, you are always using id to reference a particular tab. Just when you don't specify it, it defaults to the value provided for title for convenience.


Read this entry for more information on in-code references.

TabsIcons in Tab TitleReferencing Tabs in CodeReferencing via Tab IDs

Home Overview CLI Theme

Markdownchevron_right
Code Featureschevron_right

Images & Assets

Configurationchevron_right
Customizationchevron_right