A UI/UX Library of Patterns for Mighty Seagull
- Description
- Installation
- Documentation
- Examples
- Contributing
- Issue Template
- Pull Requests
- Membership
- License
A UI/UX Library for quick designing web apps & sites.
Note: Umbrella-X is not independed and can be used only with the Mighty Seagull Framework.
You can use Umbrella-X with two ways. Use the CSS file or the SASS files. Clone the Umbrella-X repo:
$ git clone https://github.com/retromaniacs/umbrella-x.git
or download zip.
Use the dist/css/umbrellax.css version or dist/minified/umbrellax.min.css minified one by placing one of the following in your html head section.
<link rel="stylesheet" href="dist/css/umbrellax.css">
or
<link rel="stylesheet" href="dist/minified/umbrellax.min.css">
Note: Be carefull with the path of the file
The Mighty Seagull included in both versions.
Copy the umbrella-x folder from src.
Paste it inside your SCSS folder.
Import it in your main scss file under the Mighty Seagull:
@import "seagull";
@import "umbrellax";
There are live examples with code in the umbrella-x site. See below.
You can find examples in the Umbrella-X site. Examples
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
You may contribute in several ways like creating new features, fixing bugs, improving documentation and examples.
name: Bug report
about: Create a report to help us improve
title:
labels:
assignees:
Describe the bug A clear and concise description of what the bug is.
To Reproduce Steps to reproduce the behavior:
- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error
Expected behavior A clear and concise description of what you expected to happen.
Screenshots If applicable, add screenshots to help explain your problem.
Desktop (please complete the following information):
- OS: [e.g. MACOS]
- Browser [e.g. chrome, safari]
- Version of Mighty Seagull
Additional context Add any other context about the problem here.
name: Feature request
about: Suggest an idea for this project
title:
labels:
assignees:
Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Describe the solution you'd like A clear and concise description of what you want to happen.
Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.
Additional context Add any other context or screenshots about the feature request here.
We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
Explain what other alternates were considered and why the proposed version was selected
What benefits will be realized by the code change?
What are the possible side-effects or negative impacts of the code change?
New members are welcome if they have the same philosophy with the organization.
MIT - Free Software for Everyone.