Skip to content

Commit f0cb0f8

Browse files
jonasjabarigitbook-bot
authored andcommitted
GitBook: [2.0.0] 151 pages modified
1 parent a5e56f6 commit f0cb0f8

File tree

151 files changed

+17976
-899
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+17976
-899
lines changed

docs/README.md

Lines changed: 4 additions & 748 deletions
Large diffs are not rendered by default.

docs/SUMMARY.md

Lines changed: 152 additions & 150 deletions
Large diffs are not rendered by default.

docs/changelog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ We reworked the form components quite a bit:
659659
* options passed as hashes in to `form_select`, `form_radio` and `form_checkbox` are now expected to be { label\_value: input\_value } and thus the other way around. Until 0.7.6 it was { input\_value: label\_value }
660660
* and added a lot of new features, such as customizing the error rendering.
661661

662-
We invested a lot of time to improve the `form` API docs found [here](docs/api/100-components/form.md).
662+
We invested a lot of time to improve the `form` API docs found [here](wip/docs/api/100-components/form.md).
663663

664664
* [ ] Please make sure to read through the docs and migrate your forms accordingly!
665665

docs/wip/.github/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# .github
2+

docs/wip/.github/issue_template.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# issue\_template
2+
3+
**What is the current behavior?**
4+
5+
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem. Your bug might get fixed faster if we can run your code and it doesn't have extra dependencies. Add a link to a sample repo and/or any relevant code below:**
6+
7+
**What is the expected behavior?**
8+
9+
**Which versions of Matestack, and which browser/OS are affected by this issue? Did this work in previous versions of Matestack?**
10+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# pull\_request\_template
2+
3+
**Note:** If you submit a feature or bugfix PR, pick **develop** as target branch \(and delete this line afterwards\).
4+
5+
## Issue [https://github.com/matestack/matestack-ui-core/issues/XXX](https://github.com/matestack/matestack-ui-core/issues/XXX): Short description here
6+
7+
### Changes
8+
9+
* [ ] Describe the changes in one or more bulletpoints
10+
11+
### Notes
12+
13+
* Let the reviewers know something special
14+

docs/wip/code_of_conduct.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or
20+
21+
advances
22+
23+
* Trolling, insulting/derogatory comments, and personal or political attacks
24+
* Public or private harassment
25+
* Publishing others' private information, such as a physical or electronic
26+
27+
address, without explicit permission
28+
29+
* Other conduct which could reasonably be considered inappropriate in a
30+
31+
professional setting
32+
33+
## Our Responsibilities
34+
35+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
36+
37+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
38+
39+
## Scope
40+
41+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
42+
43+
## Enforcement
44+
45+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at pascal@matestack.io. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
46+
47+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
48+
49+
## Attribution
50+
51+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
52+
53+
For answers to common questions about this code of conduct, see [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq)
54+

docs/wip/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# docs
2+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Core Components
2+
3+
Matestack provides you with a wide set of core components that enable you to easily build your UI.
4+
5+
Please use the sidebar to navigate to the component documentations.
6+
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Matestack Core Component: Abbr
2+
3+
The HTML `<abbr>` tag, implemented in Ruby.
4+
5+
## Parameters
6+
7+
This component expects 1 required param and various optional configuration params and can either yield content or display what gets passed to the `text` configuration param.
8+
9+
### Title - required
10+
11+
Expects a string with the meaning of the abbreviation contained within the tag.
12+
13+
### Text \(optional\)
14+
15+
Expects a string which will be displayed as the content inside the `<abbr>` tag. If this is not passed, a block must be passed instead.
16+
17+
### HMTL attributes \(optional\)
18+
19+
This component accepts all the canonical [HTML global attributes](https://www.w3schools.com/tags/ref_standardattributes.asp) like `id` or `class`.
20+
21+
## Examples
22+
23+
### Example 1 - render options\[:text\] param
24+
25+
```ruby
26+
abbr title: 'Hypertext Markup Language', text: 'HTML'
27+
```
28+
29+
returns
30+
31+
```markup
32+
<abbr title="Hypertext Markup Language">HTML</abbr>
33+
```
34+
35+
### Example 2 - yield a given block
36+
37+
```ruby
38+
abbr title: 'Cascading Style Sheets' do
39+
span text: 'CSS'
40+
end
41+
```
42+
43+
returns
44+
45+
```markup
46+
<abbr title="Cascading Style Sheets"><span>CSS</span></abbr>
47+
```
48+

0 commit comments

Comments
 (0)