Escaped 🏃🏻‍♂️‍➡️ for Astro 🚀

🏃🏻‍♂️‍➡️ An Astro component that holds only HTML-encoded content. 📜

💖 Support further development
I work hard for every project, including this one
and your support means a lot to me!

Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊

@igorskyflyer

🕵🏼 Usage

Install it by executing:

npm i -D "@igor.dvlpr/astro-escaped-component"

🤹🏼 API

The API exposes a single Astro component Escaped, see a usage example below.

After importing the component into a project, add it to an Astro page markup as:

<Escaped is:raw>
 {/* text/code to be escaped */}
</Escaped>

[!IMPORTANT] The attribute is:raw is crucial for the component to work, if not specified, Astro will parse all content as pure HTML, including <script> and <style> tags.

[!CAUTION] This component escapes/encodes text using HTML entities and can help prevent XSS attacks. However, this may not be sufficient in all cases.

Ensure additional security measures are in place.

✨ Examples

`example.astro` ```astro

import Escaped from '@igor.dvlpr/astro-escaped-component'

Mitochondria are known as the "powerhouses" of the cell because they generate most of the cell's supply of ATP & CO₂, which is used as a source of chemical energy.

<, >, ", ', &, =, `, !, @, $, %, (, ), +, {, }, [, ].

{/*

Will be rendered as:

Mitochondria are known as the "powerhouses" of the cell because they generate most of the cell's supply of ATP & CO<sub>2</sub>, which is used as a source of chemical energy.

<, >, ", ', &, =, `, !, @, $, %, (, ), +, {, }, [, ].

*/}


---

## 📝 Changelog

📑 The changelog is available here: [CHANGELOG.md](https://github.com/igorskyflyer/npm-astro-escaped-component/blob/main/CHANGELOG.md).

---

## 🪪 License

Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-astro-escaped-component/blob/main/LICENSE).

---

## 🧬 Related

[@igor.dvlpr/common-types](https://www.npmjs.com/package/@igor.dvlpr/common-types)

> _🔦 Provides frequently used types for your TypeScript projects. 🦄_

<br>

[@igor.dvlpr/registry-apppaths](https://www.npmjs.com/package/@igor.dvlpr/registry-apppaths)

> _🪀 A Node.js module for reading the AppPaths registry key on Windows. Useful for retrieving applications that can be launched from the command prompt. 🗃_

<br>

[@igor.dvlpr/scrollend-polyfill](https://www.npmjs.com/package/@igor.dvlpr/scrollend-polyfill)

> _🛴 A performant and light (< 1.5KB) JavaScript polyfill for the scrollend Event. ⛸️_

<br>

[@igor.dvlpr/astro-easynav-button](https://www.npmjs.com/package/@igor.dvlpr/astro-easynav-button)

> _🧭 Add an easy-to-use navigational button (jump to top/bottom) to your Astro site. 🔼_

<br>

[@igor.dvlpr/windev](https://www.npmjs.com/package/@igor.dvlpr/windev)

> _🍃 Provides ways of checking whether a path is a legacy Windows device. 💾_

---

<br>

### 👨🏻‍💻 Author
Created by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).

@igor.dvlpr/astro-escaped-component

Package Exports

Readme