cadells-vanilla-components
Advanced tools
A basic component library built with [vanilla-extract](https://vanilla-extract.style/) for use in my NextJS sites, namely [prawn.cadell.dev](https://prawn.cadell.dev/) and [emojis.cadell.dev](https://emojis.cadell.dev/).
A basic component library built with vanilla-extract for use in my NextJS sites, namely prawn.cadell.dev and emojis.cadell.dev.
It uses tsup and np for building and publishing to NPM.
npm run build - Build the package.npm run release - Publish a new version to NPM.npm run build-release - Build and Publish to NPM.Cadell's NextJS Template uses this package.
npm install cadells-vanilla-components @fontsource/source-sans-pro
npm install --save-dev @next/mdx
npm install --save-dev @vanilla-extract/css @vanilla-extract/next-plugin
next.config.js.
const withMDX = require("@next/mdx")({
extension: /\.mdx$/,
});
const { createVanillaExtractPlugin } = require("@vanilla-extract/next-plugin");
const withVanillaExtract = createVanillaExtractPlugin();
const nextConfig = {
pageExtensions: ["js", "jsx", "ts", "tsx", "md", "mdx"],
};
module.exports = withVanillaExtract(withMDX(nextConfig));
_document.tsx inside /pages.
import { InitialiseTheme } from "cadells-vanilla-components";
import Document, { Html, Head, Main, NextScript } from "next/document";
export default class MyDocument extends Document {
static async getInitialProps(ctx: any) {
const initialProps = await Document.getInitialProps(ctx);
return { ...initialProps };
}
render() {
return (
<Html lang="en">
<Head>
<link
rel="icon"
href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>😏</text></svg>"
/>
</Head>
<body>
<InitialiseTheme />
<Main />
<NextScript />
</body>
</Html>
);
}
}
_app.tsx inside /pages.
import { Container, ThemeToggle } from "cadells-vanilla-components";
import "cadells-vanilla-components/dist/index.css";
import "@fontsource/source-sans-pro/400.css";
import "@fontsource/source-sans-pro/600.css";
const App = ({ Component, pageProps }) => (
<Container>
<ThemeToggle />
<Component {...pageProps} />
</Container>
);
export default App;
mdx-components.tsx.
import { mdComponents } from "cadells-vanilla-components";
export function useMDXComponents() {
return mdComponents;
}
References:
I've built NextJS apps with MDX and custom components for projects like prawn.cadell.dev before but I wanted to split this out into a separate package for emojis.cadell.dev. This is the result! I also created template.cadell.dev as a template for showing how to use it.
Creating this package was a bit harder than first thought but I'm happy with the result and I think emojis.cadell.dev looks great. I originally tried using tsdx but the typescript types weren't correct and I couldn't work out why. I decided to change direction and started looking for a tool based on esbuild instead of Rollup and found tsup which pretty much worked out of the box. Happy days! Tsdx did introduce me to np for publishing to NPM so I kept that and it works really well. Everything happened for a reason.
FAQs
A basic component library built with [vanilla-extract](https://vanilla-extract.style/) for use in my NextJS sites, namely [prawn.cadell.dev](https://prawn.cadell.dev/) and [emojis.cadell.dev](https://emojis.cadell.dev/).
The npm package cadells-vanilla-components receives a total of 0 weekly downloads. As such, cadells-vanilla-components popularity was classified as not popular.
We found that cadells-vanilla-components demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.