3.0.0-alpha.17 • Published 4 months ago

@yozora/react-code v3.0.0-alpha.17

Weekly downloads
8
License
MIT
Repository
github
Last release
4 months ago

This component is for rendering the Code data produced by @yozora/tokenizer-indented-code and @yozora/tokenizer-fenced-code.\ This component has been built into @yozora/react-markdown, you can use it directly.

Install

  • npm

    npm install --save @yozora/react-code
  • yarn

    yarn add @yozora/react-code

Usage

  • Basic:

    import React from 'react'
    import Code from '@yozora/react-code'
    
    const wrapper = (
      <Code
        lang="typescript"
        value="let a: number = 1 + 2;"
      />
    )

Props

NameTypeRequiredDefaultDescription
classNamestringfalse-Root css class
darkenbooleanfalse-Enable the darken mode
langstringfalse-Language of the source codes
metastringfalse-Meta data of the code block
showCodeLinenobooleanfalsetrueDisplay linenos in default
runnersCodeRunnerItem[]falseSee belowCode runners.
styleReact.CSSPropertiesfalse-Root css style
valuestringtrue-Literal source codes
  • runners:

    import JsxRenderer from '@yozora/react-code-renderer-jsx'
    
    const defaultRunners: CodeRunnerItem[] = [
      {
        title: 'jsx',
        pattern: /^jsx$/,
        runner: function JsxRunner(props: CodeRunnerProps): React.ReactElement {
          const { value, scope, onError } = props
          return (
            <JsxRenderer
              code={value}
              inline={true}
              scope={scope}
              onError={onError}
            />
          )
        },
      },
    ]
  • meta:

    import type { ICodeMetaData as IBaseCodeMetaData } from '@yozora/core-react-renderer'
    import type { ICodeRunnerItem, ICodeRunnerMetaData } from '@yozora/react-code-runners'
    
    /**
    * Meta data of the fenced-code.
    */
    export interface ICodeMetaData extends IBaseCodeMetaData, ICodeRunnerMetaData {
      /**
      * Rendering mode.
      */
      _yozoracodemode: 'live' | 'embed' | 'literal' | string
    }

Related

3.0.0-alpha.17

4 months ago

3.0.0-alpha.16

4 months ago

3.0.0-alpha.14

9 months ago

3.0.0-alpha.15

8 months ago

3.0.0-alpha.13

1 year ago

3.0.0-alpha.7

2 years ago

3.0.0-alpha.6

2 years ago

3.0.0-alpha.9

2 years ago

3.0.0-alpha.8

2 years ago

3.0.0-alpha.1

2 years ago

3.0.0-alpha.0

2 years ago

3.0.0-alpha.3

2 years ago

3.0.0-alpha.2

2 years ago

3.0.0-alpha.5

2 years ago

3.0.0-alpha.4

2 years ago

3.0.0-alpha.10

2 years ago

3.0.0-alpha.12

2 years ago

3.0.0-alpha.11

2 years ago

2.3.4

2 years ago

2.3.3

2 years ago

2.3.0

2 years ago

2.3.2

2 years ago

2.3.1

2 years ago

2.0.0-alpha.7

3 years ago

2.2.1

2 years ago

2.2.0

2 years ago

2.0.2

3 years ago

2.0.0-alpha.5

3 years ago

2.2.2

2 years ago

2.0.0-alpha.6

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

2.1.0

3 years ago

2.1.0-alpha.4

3 years ago

2.1.0-alpha.3

3 years ago

2.1.0-alpha.2

3 years ago

2.1.0-alpha.1

3 years ago

2.1.0-alpha.0

3 years ago

2.0.0-alpha.3

3 years ago

2.0.0-alpha.4

3 years ago

2.0.0-alpha.0

3 years ago

2.0.0-alpha.1

3 years ago

2.0.0-alpha.2

3 years ago

1.0.0-alpha.38

4 years ago

1.0.0-alpha.39

4 years ago

1.0.0-alpha.40

4 years ago

1.0.0-alpha.37

4 years ago

1.0.0-alpha.34

4 years ago

1.0.0-alpha.36

4 years ago

1.0.0-alpha.35

4 years ago

1.0.0-alpha.33

4 years ago

1.0.0-alpha.32

4 years ago

1.0.0-alpha.31

4 years ago

1.0.0-alpha.30

4 years ago

1.0.0-alpha.29

4 years ago

1.0.0-alpha.28

4 years ago

1.0.0-alpha.27

4 years ago

1.0.0-alpha.26

4 years ago

1.0.0-alpha.25

4 years ago

1.0.0-alpha.24

4 years ago

1.0.0-alpha.23

4 years ago

1.0.0-alpha.21

4 years ago

1.0.0-alpha.22

4 years ago

1.0.0-alpha.20

4 years ago

1.0.0-alpha.19

4 years ago

1.0.0-alpha.18

4 years ago

1.0.0-alpha.17

4 years ago

1.0.0-alpha.16

4 years ago

1.0.0-alpha.15

4 years ago

1.0.0-alpha.14

4 years ago

1.0.0-alpha.13

4 years ago

1.0.0-alpha.9

4 years ago

1.0.0-alpha.8

4 years ago

1.0.0-alpha.7

4 years ago

1.0.0-alpha.6

4 years ago

1.0.0-alpha.10

4 years ago

1.0.0-alpha.5

4 years ago

1.0.0-alpha.4

4 years ago

1.0.0-alpha.3

4 years ago

1.0.0-alpha.12

4 years ago

1.0.0-alpha.11

4 years ago

1.0.0-alpha.2

4 years ago

1.0.0-alpha.1

4 years ago

1.0.0-alpha.0

4 years ago

0.0.10

4 years ago

0.0.9

4 years ago

0.0.8

4 years ago

0.0.7

4 years ago

0.0.6

5 years ago

0.0.5

5 years ago

0.0.4

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago