GithubHelp home page GithubHelp logo

vantaboard / magui Goto Github PK

View Code? Open in Web Editor NEW
1.0 0.0 0.0 779 KB

๐Ÿ’„ Reakit theme developed with TypeScript

License: MIT License

JavaScript 81.91% PowerShell 13.51% Shell 3.94% TypeScript 0.64%
ui ui-components typescript reakit

magui's Introduction

Mag UI

license Commitizen friendly Renovate status Follow on Twitter

๐Ÿ‘  Features

  • Accessible due to Reakit
  • Full color palette
  • Light theme / dark theme
  • Style dictionary
  • Neat animations

๐Ÿงฑ Stack

Changelog

If you have recently updated, please read the changelog for details of what has changed.

๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘ Contributing

Read the contributing guide to learn about our development process, and how to craft proposals.

โš–๏ธ License

This project is licensed under the terms of the MIT license.

magui's People

Contributors

renovate-bot avatar semantic-release-bot avatar vantaboard avatar

Stargazers

 avatar

magui's Issues

Modal component

Summary

Creation of a styled modal component.

Examples

A box that dims the background and displays important information to the user.

Why

Modals are useful for blocking a view with information that must be seen before a user continues through the application.

FAB component

Summary

Creation of a styled floating action button component.

Examples

A button that floats at some orientation on the document window that can be popped out for selection of an array of items.

Why

Floating action buttons can be used to simplify page navigation.

Tooltip component

Summary

Creation of a styled tooltip component.

Examples

Element that comes into view when hovering over specific components.

Why

Tooltips provide descriptive textual information for otherwise visual components like icons.

Checkbox component

Summary

Creation of a styled checkbox component.

Examples

Multi-selection boxes.

  • Such as
  • these

Why

Checkboxes are useful for logic that may require plural selection.

Icon component

Summary

Creation of an icon component.

Examples

A component that can be used to hold icons in SVG format.

Why

Icons are useful for adding visual indicators as guides for UX.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

  • chore(deps): bump reakit to ^1.3.10
  • chore(deps): bump styled-components to ^5.3.1
  • chore(deps): bump @babel/helper-compilation-targets to ^7.15.4
  • chore(deps): bump polished to ^4.1.3
  • chore(deps): bump @semantic-release/commit-analyzer to 12.0.0
  • chore(deps): bump @semantic-release/npm to 12.0.0
  • chore(deps): bump @semantic-release/release-notes-generator to 13.0.0
  • chore(deps): bump @storybook/addon-actions to 8.0.10
  • chore(deps): bump @storybook/addon-essentials to 8.0.10
  • chore(deps): bump @storybook/addon-links to 8.0.10
  • chore(deps): bump @storybook/react to 8.0.10
  • chore(deps): bump @types/node to 20.12.8
  • chore(deps): bump @typescript-eslint/eslint-plugin to 7.8.0
  • chore(deps): bump @typescript-eslint/parser to 7.8.0
  • chore(deps): bump actions/checkout action to v4
  • chore(deps): bump actions/setup-node action to v4
  • chore(deps): bump dotenv-cli to 7.4.1
  • chore(deps): bump eslint to 9.2.0
  • chore(deps): bump eslint-config-prettier to 9.1.0
  • chore(deps): bump eslint-plugin-prettier to 5.1.3
  • chore(deps): bump fork-ts-checker-webpack-plugin to 9.0.2
  • chore(deps): bump husky to 9.0.11
  • chore(deps): bump lint-staged to 15.2.2
  • chore(deps): bump prettier to 3.2.5
  • chore(deps): bump pretty-quick to 4.0.0
  • chore(deps): bump semantic-release to 23.0.8
  • chore(deps): bump storybook to 8.0.10
  • chore(deps): bump styled-components to ^6.0.0
  • chore(deps): bump typescript to 5.4.5
  • ๐Ÿ” Create all rate-limited PRs at once ๐Ÿ”

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

github-actions
.github/workflows/release.yml
  • actions/checkout v2
  • actions/setup-node v2
npm
package.json
  • polished ^4.1.3
  • react ^17.0.2
  • react-dom ^17.0.2
  • reakit ^1.3.10
  • styled-components ^5.3.1
  • @babel/core 7.15.8
  • @babel/helper-compilation-targets ^7.15.4
  • @semantic-release/changelog 6.0.0
  • @semantic-release/commit-analyzer 9.0.1
  • @semantic-release/git 10.0.0
  • @semantic-release/npm 8.0.2
  • @semantic-release/release-notes-generator 10.0.2
  • @storybook/addon-actions 6.3.12
  • @storybook/addon-essentials 6.3.12
  • @storybook/addon-links 6.3.12
  • @storybook/react 6.3.12
  • @types/node 16.11.4
  • @types/react 17.0.31
  • @types/react-dom 17.0.10
  • @types/styled-components 5.1.15
  • @typescript-eslint/parser 5.1.0
  • @typescript-eslint/eslint-plugin 5.1.0
  • babel-loader 8.2.3
  • babel-plugin-styled-components 1.13.3
  • commitizen 4.2.4
  • cz-conventional-changelog 3.3.0
  • dotenv-cli 4.0.0
  • eslint 8.1.0
  • eslint-config-prettier 8.3.0
  • eslint-import-resolver-typescript 2.5.0
  • eslint-plugin-import 2.25.2
  • eslint-plugin-jsx-a11y 6.4.1
  • eslint-plugin-prettier 4.0.0
  • eslint-plugin-react 7.26.1
  • eslint-plugin-react-hooks 4.2.0
  • lint-staged 11.2.4
  • husky 7.0.4
  • fork-ts-checker-webpack-plugin 6.4.0
  • prettier 2.4.1
  • pretty-quick 3.1.1
  • semantic-release 18.0.0
  • storybook 6.3.12
  • style-dictionary 3.0.3
  • ts-loader 9.2.6
  • tsconfig-paths-webpack-plugin 3.5.1
  • typescript 4.4.4

  • Check this box to trigger a request for Renovate to run again on this repository

style-dictionary sizing

Summary

Submit sizing properties for style-dictionary.

Examples

Sizes for margins, padding, etc.

Why

Build up dictionary for styling Mag UI.

Button component

Summary

Creation of a styled button component.

Examples

A rounded button used for primary, secondary, success, error, and warning actions.

Why

Buttons are some of the most common navigation elements in a given application.

Disclosure component

Summary

Creation of a styled disclosure component.

Examples

Moves like an accordion to display disclosed information.

Why

Disclosures are useful for showing optional information as well as information that may already be known to the user.

style-dictionary breakpoints

Summary

Submit breakpoint properties for style-dictionary.

Examples

Breakpoints for specific screen sizes.

Why

Build up dictionary for styling Mag UI.

Card component

Summary

Creation of a styled card component.

Examples

A rounded container for storing children inside of.

Why

A card will add to the desired aesthetic for Mag UI.

Container component

Summary

Creation of a container component.

Examples

Margins that determine a containment for all of the elements on a page.

Why

Without a container, margins may be browser-specific which makes it harder to create a shared user experience across platforms.

Tab component

Summary

Creation of a styled tab component.

Examples

Selections for moving through routes on a page.

Why

Tabs are a way of maintaining fluid navigation without making a user have to maneuver too far from where they began.

Add react popper

Summary

React popper can serve as a way of easily manipulating the position of popover elements.

Grid component

Summary

Creation of a styled grid component.

Examples

Grid that styles itself based on breakpoints defined in the style dictionary.

Why

Grids are useful for ensuring information is displayed in a practical way on displays of varying resolution and dimension ratios.

Dropdown component

Summary

Creation of a styled dropdown component.

Examples

A dropdown menu that expands when clicked.

Why

Dropdown menus are useful for navigation and most commonly attached to headers.

Footer component

Summary

Creation of a styled footer component.

Examples

A navigation bar that persists at the bottom of every route.

Why

Footers are a common navigation device that Mag UI developers and users will no doubt want access to.

Popover component

Summary

Creation of a styled popover component.

Examples

An element similar to a modal but that does not obscure important or large portions of the page.

Why

Popovers can be used like tooltips that are manually triggered.

Separator component

Summary

Creation of a styled separator component.

Examples

A visual boundary for separating content.

Why

Not always visible, separators can be used for creating accessible pages by separating information.

style-dictionary typography

Summary

Submit typography properties for style-dictionary.

Examples

Font size and font family.

Why

Build up dictionary for styling Mag UI.

Deploy Storybook as github.io

Summary

Creation of a new branch to host the distribution of Storybook's built assets.

Examples

Posting the github.io as a website on the main repo page.

Why

This will allow easy previewing of the style of Mag UI for people new to the theme.

Avatar component

Summary

Creation of a styled avatar component.

Examples

Container for holding user avatars that that maintains a default form for users without images to pull from.

Why

Avatars enhance the feeling of community involvement in an application and are also useful for identification purposes.

Form component

Summary

Creation of a styled form component.

Examples

A form component for creating structures that allow user input such as contact forms, and log in / registration forms.

Why

Forms are useful for interacting with a database as well as authentication purposes.

Portal component

Summary

Creation of a styled portal component.

Examples

Component that is isolated from the current DOM heirarchy.

Why

Portals are useful for isolating elements such as with modals.

Header component

Summary

Creation of a styled header component.

Examples

A navigation bar that persists at the top of every route.

Why

Headers are a common navigation device that Mag UI developers and users will no doubt want access to.

Typography component

Summary

Creation of a styled typography component.

Examples

A text wrapper that allows for selecting header types as well as sizes determined by the style dictionary.

Why

Easier manipulation of text.

Carousel component

Summary

Creation of a styled carousel component.

Examples

A component that cycles through a set of graphics.

Why

Carousels are good ways of presenting important pieces of information while also using animation to enhance UX.

Box component

Summary

Creation of a styled box component.

Examples

A wrapper for elements that is styled as flex display.

Why

This acts as a good base for further manipulation and abstracts flex styling.

Radio component

Summary

Creation of a styled radio component.

Examples

Circular single-selection buttons.

Why

Radio buttons are useful in contexts where the selected information is singular.

Stack component

Summary

Creation of a styled stack component.

Examples

A container that aligns the items with vertically in a column in a form that resembles a stack.

Why

This container will ease the creation of stack by abstracting the process of styling a wrapper to vertically align the elements within.

Input component

Summary

Creation of a styled input component.

Examples

Name and number inputs with prefixes and suffixes.

Why

Inputs are useful for gathering information to be processed by business logic.

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.