1.1.0 • Published 6 months ago

react-prismjs-component v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Features

  • 🔍 Syntax Highlighting: Real-time code highlighting using PrismJS
  • 🎨 Multiple Themes: Supports 7 built-in themes (dark and light both themes)
  • 📝 Language Support: Out-of-the-box support for 25+ programming languages
  • 📋 Copy to Clipboard: Built-in code copying functionality
  • 🔢 Line Numbers: Integrated line numbering support
  • 🖼️ Custom Icons: Ability to customize file icons for different languages
  • Dynamic Loading: Lazy loads language and theme files for better performance
  • 🎯 Error Handling: Built-in error boundaries for theme and language loadingfeedback

Table of Contents

Installation

npm i react-prismjs-component

Usage

Here's a quick example of how to use the library:

import CodeSnippet from "react-prismjs-component";

function App() {
    const sampleCode = `console.log('Hello World');`;

    return (
        <div>
            <CodeSnippet
                code={sampleCode}
                language="javascript"
                theme="okaidia"
                codeIcon="/path/to/icon.svg"
                width="1000px"
            />
        </div>
    );
}

export default App;

Props for CodeSnippet

Prop NameTypeDefaultDescription
codestringRequiredThe code snippet to display.
languagestringmarkupThe programming language for syntax highlighting.
themestringdefaultThe theme to use for syntax highlighting.
codeIconstringnullPath to a custom icon for the code file.
widthstring800pxWidth of the CodeSnippet component.

Supported Themes

The following themes are supported:

  • okaidia
  • tomorrow
  • dark
  • default
  • twilight
  • coy
  • solarizedlight

To apply a theme, pass its name to the theme prop.

Supported Languages

The following languages are supported out of the box:

Pass the language name (in lowercase) to the language prop.

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature (git checkout -b feature-name).
  3. Commit your changes (git commit -m "Add some feature").
  4. Push to the branch (git push origin feature-name).
  5. Open a pull request.

Credits

License

This library is licensed under the MIT License.

1.1.0

6 months ago

1.0.9

6 months ago

0.1.5

6 months ago

0.1.1

6 months ago

0.1.0

6 months ago

0.0.1

6 months ago

1.0.1

6 months ago

1.0.0

6 months ago