@genexus/gemini

Gemini Design System

A design system for GeneXus IDEs (GeneXus M and GeneXus for Windows).

Here you can find an overview of palette, typography, styles, and components.

You can try the design system components here.

Getting Started

npm install
npm start

Running the tests

To run the unit tests for the custom elements, run:

npm test

Building for production

To build the design for production, run:

npm run build

Using this design system

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/@genexus/gemini/dist/gemini.js'></script> in the head of your index.html
• Put a link tag similar to this <link href="https://unpkg.com/@genexus/gemini/dist/gemini/gemini.css" rel="stylesheet" /> in the head of your index.html
• Then you can start using the layout editor in your template, JSX, html etc.

Node Modules

• Run npm install @genexus/gemini --save
• Put a script tag similar to this <script src='node_modules/@genexus/gemini/dist/gemini.js'></script> in the head of your index.html
• Put a link tag similar to this <link href="node_modules/@genexus/gemini/dist/gemini/gemini.css" rel="stylesheet" /> in the head of your index.html
• Then you can start using the layout editor in your template, JSX, html etc.

Dark Theme

• Simply add the dark class to the html tag.

Right to left reading direction

• Gemini also works with "right to left" reading direction languages. Just set the dir attribute value to rtl on the html tag.

Using this design system with Stencil

Install Gemini

• npm install @genexus/gemini --save
• Install the SASS plugin for Stencil: npm install @stencil/sass --save-dev
• Edit stencil.config.ts as explained here.
• Also, add globalStyle in stencil.config.ts pointing to src/globals/global.scss

The stencil.config.ts file should look something like this:

import { Config } from "@stencil/core";
import { sass } from "@stencil/sass";

export const config: Config = {
   namespace: "project-name",
   outputTargets: [
      {
         type: "dist",
         esmLoaderPath: "../loader"
      },
      {
         type: "docs-readme"
      },
      {
         type: "www",
         serviceWorker: null
      }
   ],
   globalStyle: "src/globals/global.scss",
   plugins: [sass()]
};

• Create the global.scss file under src/globals.
• Add an import to Gemini's stylesheet inside global.scss:

@import "../../node_modules/@genexus/gemini/dist/gemini/gemini.css";

• Add an import to Gemini's JavaScript file inside src/index.ts: import "@genexus/gemini";
• After defining a globalStyle in point 4, your components library will output a CSS file. You must include this CSS file in your src/index.html file. The name of the stylesheet will be the same as the project name: <link rel="stylesheet" href="/build/project-name.css" />
• Done! You can now consume Gemini's web components and use its CSS variables: <gxg-button>Button</gxg-button>

Authors

See the list of contributors who participated in this project.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.