Readme
This commit is contained in:
parent
93b6c02acb
commit
48677a610e
3 changed files with 121 additions and 85 deletions
202
README.md
202
README.md
|
|
@ -1,92 +1,128 @@
|
||||||
# Stear
|
# Stear
|
||||||
|
|
||||||
|
# Stear
|
||||||
|
## Introduction
|
||||||
|
A simple Framework. Its more a try to get a WindowManger and getting rid of self written HTML and CSS
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
### Create Stear Instance
|
||||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
```javascript
|
||||||
|
import { Stear, SWindow } from "./stear/main.js";
|
||||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
var stear = new Stear(document.querySelector("#stear"));
|
||||||
|
|
||||||
## Add your files
|
|
||||||
|
|
||||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
|
||||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
cd existing_repo
|
### Addind Windows
|
||||||
git remote add origin https://gitlab.com/jusax23/stear.git
|
|
||||||
git branch -M main
|
```javascript
|
||||||
git push -uf origin main
|
stear.addElement("connect", new SWindow(connect));
|
||||||
|
stear.addElement("start", new SWindow(start));
|
||||||
|
```
|
||||||
|
Windows don't necessarily have to be add this Way, but it is recommented.
|
||||||
|
|
||||||
|
An SWindow is an Extendion of the SFrame class. SWindow adds an DIV Element around the page content in Fullscreen.
|
||||||
|
|
||||||
|
### Calling Windows
|
||||||
|
```javascript
|
||||||
|
stear.call(stear.g("start"), {});
|
||||||
|
```
|
||||||
|
The first Argument must be an SFrame Instance. The secound Argument can be used to pass Data to the new Window.
|
||||||
|
|
||||||
|
An Window/Frame is could be build by extending SFrame or SWindow, but the recommanded way is to create an ES6 Module and passing it into the SWindow or SFrame class
|
||||||
|
|
||||||
|
### Creating a Window
|
||||||
|
```javascript
|
||||||
|
import { _ } from "./stear/main.js";
|
||||||
|
import { fadein, fadeout, wait } from "./stear/utils.js";
|
||||||
|
|
||||||
|
|
||||||
|
export const preRender = true;
|
||||||
|
|
||||||
|
export const render = ({}, {}) => {
|
||||||
|
|
||||||
|
return _({}, [
|
||||||
|
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
export const call = async (stear, { find, resolve, render, call }, args) => {
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
**preRender**: If actived render() will only be called once. If deactived you have to call the provided render() function in the call() function yourself.
|
||||||
|
|
||||||
|
**render**: A sync function returning your Page Content. (for Detail look deeper) The first Argument is not used right now. The scound one can contain Args passt in the render() function inside call().
|
||||||
|
|
||||||
|
**call**: When calling a Window this function will be called. The first Argument is the used Stear Instance. The secound Argument contains some SterungTools. The third Argument are the Arguments passt in the call request.
|
||||||
|
|
||||||
|
### Creating Page Content / class_ class
|
||||||
|
```javascript
|
||||||
|
_({
|
||||||
|
find:"someString",
|
||||||
|
type:"div",
|
||||||
|
style:{
|
||||||
|
color:"#fff",
|
||||||
|
backgroundColor:"black",
|
||||||
|
},
|
||||||
|
//other Attributes
|
||||||
|
},[
|
||||||
|
//pass here other class_ Instances
|
||||||
|
])
|
||||||
|
```
|
||||||
|
The function _(settings, childs) returns an class\_ Instance.
|
||||||
|
|
||||||
|
Attributes of the Settings Object while be applyed as HTML-Element Attribute.
|
||||||
|
Exeptions are find, type and style (all can be empty):
|
||||||
|
|
||||||
|
**type**: The type Attribute determines the DOMElement Type. The Default is div.
|
||||||
|
|
||||||
|
**find**: The find Attribute is an identifier for the call() function. With find.someString you can get this Element. With find.someString._ you get the underlying DOMElement.
|
||||||
|
|
||||||
|
**style**: The content of the style Attribute will be applied as css style.
|
||||||
|
|
||||||
|
Other Methodes:
|
||||||
|
```javascript
|
||||||
|
var element = _({},[]);
|
||||||
|
var newRenderedHTMLElement = element.render ;
|
||||||
|
var HTMLElement = element._ ; //Same as line befor when Element was completly rendered
|
||||||
|
element.childs = [
|
||||||
|
//Overrides the secound Argument
|
||||||
|
];
|
||||||
|
element.settings = {
|
||||||
|
//Overrides first Argument (when possible)
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Integrate with your tools
|
### Globel functions
|
||||||
|
|
||||||
- [ ] [Set up project integrations](https://gitlab.com/jusax23/stear/-/settings/integrations)
|
#### Adding Global CSS the Oldway
|
||||||
|
```javascript
|
||||||
|
Stear.addGlobalStyleText(`
|
||||||
|
.cssClass {
|
||||||
|
color: #fff;
|
||||||
|
background-color:black;
|
||||||
|
}
|
||||||
|
`);
|
||||||
|
```
|
||||||
|
#### Adding Global CSS the with JSON
|
||||||
|
```javascript
|
||||||
|
var name = ".cssClass";
|
||||||
|
name = Stear.addGlobalStyleJSON({
|
||||||
|
color: "#fff",
|
||||||
|
backgroundColor: "black",
|
||||||
|
},name);
|
||||||
|
```
|
||||||
|
The Function can add CSS like CSS can be added to Elements in Pages. When leaving name empty a cssClass will be added with a sortof random name.
|
||||||
|
|
||||||
## Collaborate with your team
|
#### Adding CSS Animations the with JSON
|
||||||
|
```javascript
|
||||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
var KeyframeName = Stear.addAnimation({
|
||||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
"0%":{
|
||||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
transform: "scale(100%)",
|
||||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
},
|
||||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
"50%": {
|
||||||
|
transform: "scale(110%)",
|
||||||
## Test and Deploy
|
},
|
||||||
|
"100%": {
|
||||||
Use the built-in continuous integration in GitLab.
|
transform: "scale(100%)",
|
||||||
|
}
|
||||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
}/*,name*/);
|
||||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
```
|
||||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
|
||||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
|
||||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
# Editing this README
|
|
||||||
|
|
||||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
|
||||||
|
|
||||||
## Suggestions for a good README
|
|
||||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
|
||||||
|
|
||||||
## Name
|
|
||||||
Choose a self-explaining name for your project.
|
|
||||||
|
|
||||||
## Description
|
|
||||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
|
||||||
|
|
||||||
## Badges
|
|
||||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
|
||||||
|
|
||||||
## Visuals
|
|
||||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
|
||||||
|
|
||||||
## Support
|
|
||||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
State if you are open to contributions and what your requirements are for accepting them.
|
|
||||||
|
|
||||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
|
||||||
|
|
||||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
|
||||||
|
|
||||||
## Authors and acknowledgment
|
|
||||||
Show your appreciation to those who have contributed to the project.
|
|
||||||
|
|
||||||
## License
|
|
||||||
For open source projects, say how it is licensed.
|
|
||||||
|
|
||||||
## Project status
|
|
||||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
|
||||||
|
|
@ -26,7 +26,7 @@ _({find:"main"},[
|
||||||
])
|
])
|
||||||
]);
|
]);
|
||||||
|
|
||||||
export const call = async (stear,{find,resolve,render},{id,name}) => {
|
export const call = async (stear, { find, resolve, render, call }, args) => {
|
||||||
find.text._.innerText = "Connecting to: " + name + " (" + id + ")";
|
find.text._.innerText = "Connecting to: " + name + " (" + id + ")";
|
||||||
await fadein(find.main._, 200, true);
|
await fadein(find.main._, 200, true);
|
||||||
//do connection
|
//do connection
|
||||||
|
|
|
||||||
2
empty.js
2
empty.js
|
|
@ -11,6 +11,6 @@ export const render = ({}, {}) => {
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
export const call = async (stear, { find, resolve, render }, { }) => {
|
export const call = async (stear, { find, resolve, render, call }, { }) => {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue