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

@w3ctech-editorial-department/craco-antd-mobile

v1.0.3

Published

A craco plugin to use Ant Design Mobile with create-react-app

Downloads

444

Readme

MIT License npm version


Craco Ant Design Mobile Plugin

This is a craco plugin that makes it easy to use the Ant Design Mobile UI library with create-react-app version >= 4.

@w3ctech-editorial-department/craco-antd-mobile includes:

Installation

First, follow the beginning section of the Ant Design Mobile create-react-app Documentation to set up your own app with Ant Design Mobile.

Then, follow the craco Installation Instructions to install the craco package, create a craco.config.js file, and modify the scripts in your package.json.

Finally, install @w3ctech-editorial-department/craco-antd-mobile and antd-mobile:

$ yarn add antd-mobile && yarn add -D @w3ctech-editorial-department/craco-antd-mobile

# OR

$ npm i antd-mobile && npm i -D @w3ctech-editorial-department/craco-antd-mobile

@w3ctech-editorial-department/craco-antd-mobile only has a "peer dependency" for antd-mobile >= 2.3.4. So you should add a suitable version of antd-mobile to your own package.json.

Basic Usage

Here is a complete craco.config.js configuration file that sets up Less compilation and babel-plugin-import for create-react-app:

const CracoAntDesignMobilePlugin = require("@w3ctech-editorial-department/craco-antd-mobile");

module.exports = {
  plugins: [{ plugin: CracoAntDesignMobilePlugin }],
};

Customize Ant Design Mobile Theme

You can modify the default Ant Design Mobile theme by changing some Less variables.

@w3ctech-editorial-department/craco-antd-mobile will look for variables in a Less file at ./antd-mobile.customize.less. (You can customize this file path with the customizeThemeLessPath option.)

@brand-primary: #00eaa9;

Here's a list of all the variables that can be modified.

You can also customize these variables directly in your craco.config.js with the customizeTheme option:

const CracoAntDesignMobilePlugin = require("@w3ctech-editorial-department/craco-antd-mobile");

module.exports = {
  plugins: [
    {
      plugin: CracoAntDesignMobilePlugin,
      options: {
        customizeTheme: {
          "@brand-primary": "#00eaa9",
        },
      },
    },
  ],
};

customizeTheme is just an alias for the modifyVars option in less-loader.

If you use multiple options to customize the theme variables, they are merged together in the following order:

  • options.customizeThemeLessPath (default: ./antd-mobile.customize.less)
  • options.customVarsJSONPath (default: ./antd-mobile.customize.json)
  • options.customizeTheme
  • options.lessLoaderOptions.modifyVars

For more information, see Ant Design Mobile's "Customize Theme" documentation.

Options

You can pass an options object to configure the loaders and plugins. You can also pass a modifyLessRule callback to have full control over the Less webpack rule. See the craco-less documentation for more information about these options:

  • options.modifyLessRule
  • options.cssLoaderOptions
  • options.lessLoaderOptions
  • options.styleLoaderOptions
  • options.postcssLoaderOptions
  • options.miniCssExtractPluginOptions

See the babel-plugin-import documentation for more information about this option:

  • options.babelPluginImportOptions

Example:

module.exports = {
  plugins: [
    {
      plugin: CracoAntDesignPlugin,
      options: {
        lessLoaderOptions: {
          lessOptions: {
            noIeCompat: true,
            strictMath: true,
            modifyVars: { "@brand-primary": "#00eaa9" },
          },
        },
        cssLoaderOptions: {
          modules: true,
          localIdentName: "[local]_[hash:base64:5]",
        },
        babelPluginImportOptions: {
          libraryDirectory: "es",
        },
      },
    },
  ],
};

License

MIT