Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style(docs): Rename migration docs with lower case #1820

Closed
wants to merge 5 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .remarkignore
literat marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -5,9 +5,3 @@ vendor
dist
build
.github

# Temporary disabled packages
# we will fix them incrementally
form-validations
# Codemods transforms directory
transforms
2 changes: 1 addition & 1 deletion docs/contribution/release-schedule.md
Original file line number Diff line number Diff line change
@@ -68,7 +68,7 @@ To get support for a specific version, please refer to the [support Slack channe

## Release Names

To get more information about the release names, please refer to the [Release Namse Decision][release-name-decision].
To get more information about the release names, please refer to the [Release Names Decision][release-names-decision].

## Assets Managed Under This Release Schedule

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Migration Guide

Introducing version 1 of the _spirit-form-validations_ package
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v2/web-react/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Web-React v2 Codemods

This is a collection of codemods for updating Web-React v2 components.
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v3/web-react/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Web-React v3 Codemods

This is a collection of codemods for updating Web-React v3 components.
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v4/web-react/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Web-React v4 Codemods

This is a collection of codemods for updating Web-React v4 components.
32 changes: 18 additions & 14 deletions packages/form-validations/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--lint disable no-emphasis-as-heading-->
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint ignore heading-capitalization-->

# @lmc-eu/spirit-form-validations

> Form validations for Web and Web-Twig packages of the Spirit Design System.
@@ -40,19 +44,19 @@ Now create a form:

… and validate it:

```
```javascript
window.onload = () => {
const form = document.getElementById("form1");
const form = document.getElementById('form1');

// create the FormValidations instance
const formValidations = new FormValidations(form);
// create the FormValidations instance
const formValidations = new FormValidations(form);

form.addEventListener('submit', function (event) {
event.preventDefault();
form.addEventListener('submit', function (event) {
event.preventDefault();

// check if the form is valid
const valid = formValidations.validate(); // returns true or false
});
// check if the form is valid
const valid = formValidations.validate(); // returns true or false
});
};
```

@@ -87,7 +91,7 @@ const defaultConfig = {

- **live** - A boolean value indicating whether FormValidations should validate as you type, default is `true`

## Built-in validators
## Built-in Validators

| Name | Usage | Description |
| --------- | ----------------------------------------------------------------------------------------------------- | ------------------------------- |
@@ -108,7 +112,7 @@ const defaultConfig = {
FormValidations.addValidator(nameOrElem, handler, errorMessage, priority, halt);
```

### Add a custom validator to a field
### Add a Custom Validator to a Field

```javascript
var formValidations = new FormValidations(document.getElementById('form1'));
@@ -130,7 +134,7 @@ FormValidations.addElementValidator(
);
```

### Add a global custom validator
### Add a Global Custom Validator

A validator to check if the input value is within a specified range.

@@ -157,7 +161,7 @@ Now you can assign it to your inputs like this
<input type="text" class="form-control" data-spirit-my-range="10,30" />
```

### Add custom error messages
### Add Custom Error Messages

```html
<input required data-spirit-required-message="My custom message" />
@@ -218,7 +222,7 @@ _Set the current locale globally_
| `locale` | — | ✓ | The corresponding locale |
| `messages` | — | ✓ | Object containing validator names as keys and error texts as values |

### Custom validators
### Custom Validators

**FormValidations.addElementValidator(elem, fn, message, priority, halt)**

20 changes: 10 additions & 10 deletions packages/web-react/src/components/Card/README.md
Original file line number Diff line number Diff line change
@@ -89,11 +89,11 @@ Card can be displayed with a border and a box shadow on hover.

### API

| Name | Type | Default | Required | Description |
| ------------- | --------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | [[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |
| Name | Type | Default | Required | Description |
| ------------- | ---------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | \[[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
@@ -220,11 +220,11 @@ horizontal (and reversed horizontal) Cards. But in all other contexts, the two p

### API

| Name | Type | Default | Required | Description |
| ---------------------- | -------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | [[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |
| Name | Type | Default | Required | Description |
| ---------------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | \[[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
1 change: 0 additions & 1 deletion packages/web-react/src/components/Footer/README.md
Original file line number Diff line number Diff line change
@@ -273,6 +273,5 @@ and [escape hatches][readme-escape-hatches].
[readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes
[readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[select]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Select/README.md
[stack]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Stack/README.md