Git Product home page Git Product logo

kube-design's Introduction

Kube Design

Kube Design is a set of React component libraries created for KubeSphere console.

NPM

Requirement

Installation

yarn add @kube-design/components

Example

import React, { Component } from "react";

import { Button } from "@kube-design/components";

class Example extends Component {
  render() {
    return <Button>Button</Button>;
  }
}

Import All Styles

There are two ways to import style files.

Use css

The css file can be imported directly, so no additional configuration is required in the webpack configuration file.

import "@kube-design/components/esm/styles/index.css";

Use scss

If you import the scss file, you may need to compile this part of the scss file in the webpack configuration file.

import "@kube-design/components/esm/styles/index.scss";

webpack.config.js

// module.rules
[
  ...otherRules,
  {
    test: /\.s[ac]ss$/i,
    include: root("node_modules"),
    use: ["style-loader", "css-loader", "sass-loader"],
  },
];

Modular Import

You can use babel-plugin-import to load the component library on demand.

When loading on demand, styles will also be imported on demand. You don't need to import all styles, only main.scss.

Configure the babel as follows:

// babel.config.js

const getBabelPluginImportConfig = require('@kube-design/components/babel.plugin.import')

...

"plugins": [
  ['import', getBabelPluginImportConfig()],
]

Import the main.scss instead of index.scss

import "@kube-design/components/esm/styles/main.scss";

Localization

Kube Design use LocaleProvider component to support localization.

  1. Define locales
// locales.js

const locales = {
  "en-US": {
    HELLO: "Hello!",
  },
  "zh-CN": {
    HELLO: "你好!",
  },
};

export default locales;
  1. Use the LocaleProvider component to wrap the root node

The locale method can be assigned to window for easy use.

import React from "react";
import ReactDOM from "react-dom";
import { LocaleProvider } from "@kube-design/components";
import locales from "./locales";
import App from "./App";

window.locale = LocaleProvider.locale;

const App = () => (
  <LocaleProvider locales={locales} currentLocale="en">
    <App />
  </LocaleProvider>
);

ReactDOM.render(<App />, document.getElementById("root"));
  1. In the root node App.jsx and its child nodes, use locale.get('key') to get the language text
import React from "react";
import { Button } from "@kube-design/components";

export default () => <Button>{locale.get("HELLO")}</Button>;

License

MIT © kubesphere

kube-design's People

Contributors

harrisonliu5 avatar yazhouio avatar xuliwenwenwen avatar fuchunlan avatar weili520 avatar dependabot[bot] avatar 51wangping avatar chenz24 avatar anuragthepathak avatar harrisonyu avatar 15155031994 avatar zheng1 avatar elichen95 avatar liuboaibc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.