npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jsx-conditionals

v1.2.0

Published

Add if-else statements to JSX with compiler transforms

Downloads

44

Readme

Build status NPM release

Add <If>, <ElseIf> and <Else> to JSX using compiler transforms.

import { If, Else, ElseIf } from 'jsx-conditionals';

<If condition={student}>
    { student.name }
</If>
<ElseIf condition={teacher}>
    { teacher!.age }{ /* TS strict mode requires the ! operator */ }
</ElseIf>
<Else>
    Both false
</Else>

Unlike other implementations, jsx-conditionals retains the lazy evaluation of ternary expressions.

In a naive implementation, student.name above would throw a 'student is not defined' error. This implementation only evaluates the necessary expressions. You can read more about it on my blog.

Because it happens at compile-time, there's no runtime dependency at all. It's purely syntactic sugar.

Install

npm install --save-dev jsx-conditionals

jsx-conditionals works by using compiler transforms. Configuration will depend on your build setup. There are two provided transformers: one for tsc, and one for Babel.

Configure your webpack.config

const jsxConditionals = require('jsx-conditionals/transform').default;
//...
module.exports = {
    //...
    module: {
        rules: [
            {
                test: /\.tsx?$/,
                use: [{
                    loader: 'ts-loader',
                    options: {
                        getCustomTransformers: (program) => ({
                            before: [jsxConditionals(program, {})]
                        })
                    }
                }]
            }
        ]
    }
}

See the Webpack and ts-loader sample.

You will additionally need to install the following

npm install -D vite-plugin-babel @babel/plugin-syntax-typescript 

Then in your vite.config.ts, configure the Babel plugin:

import babel from 'vite-plugin-babel'

export default defineConfig({
    plugins: [
        babel({
            babelConfig: {
                plugins: [
                    ['@babel/plugin-syntax-typescript', { isTSX: true }],
                    'jsx-conditionals/babel'
                ],
            },
            filter: /\.[jt]sx$/,
            exclude: "**/node_modules/**"
        })
    ],
});

If you're using Next.js, by default you are compiling with SWC. This library does not yet provide a transformation for SWC. However, if you have a .babelrc or babel.config.js then Next will compile with Babel instead. (see docs).

The downside is that Babel is slower than SWC.

Sample .babelrc:

{
  "presets": ["next/babel"],
  "plugins": ['jsx-conditionals/babel']
}

Follow the ts-patch installation/usage steps

You can now add this entry in your tsconfig.json.

{
    "compilerOptions": {
        "plugins": [
            { "transform": "jsx-conditionals/transform" },
        ]
    }
}

TypeScript strict mode

In the above example, it was shown that properties of objects checked within a condition can be safely accessed thanks to proper lazy evaluation.

In strict mode, student.name will produce an TypeScript error, since the type checker doesn't know about the semantics of <If>. In a normal if-statement, the type would be narrowed, but that's not possible here.

You need to use ! (the "non-null assertion operator"), i.e. student!.name. This is a safe assertion, and is purely to tell the compiler that we know something it doesn't.