Skip to content

Commit

Permalink
Merge pull request #48 from sitegeist/task/prepareRelease2
Browse files Browse the repository at this point in the history
Task/prepare release2
  • Loading branch information
s2b authored Apr 10, 2020
2 parents 4ac9360 + b4653b4 commit 52d5d6a
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@ Alternatively, you can install the extension from TER:

After that, proceed with [Getting Started](#getting-started)

## Updating from 1.x

There is only one breaking change: It isn't possible anymore to use Fluid variables in default values
for component parameters. This will **NOT WORK ANYMORE**:

```xml
<fc:param name="firstName" type="string" optional="1" default="{settings.defaultFirstName}" />
```

As this was a pretty esoteric feature, you shouldn't have any problems when updating to 2.x!

## What does it do?

Fluid templates usually consist of three parts:
Expand Down Expand Up @@ -107,7 +118,8 @@ The result is the following HTML:
* Components encourage **markup reusage and refactoring**. Only the component knows about its implementation
details. As long as the interface stays compatible, the implementation can change.
* Components can be a tool to **enforce design guidelines**. If the component's implementation respects the
guidelines, they are respected everywhere the component is used.
guidelines, they are respected everywhere the component is used. A helpful tool to accomplish that is the corresponding
living styleguide: [Fluid Styleguide](https://github.com/sitegeist/fluid-styleguide).
* Components **formalize and improve communication**. Frontend developers and integrators agree on a clearly
defined interface instead of debating implementation details.
* Components **reduce dependencies**. Frontend developers can work independent of integrators and backend developers.
Expand Down Expand Up @@ -138,6 +150,8 @@ the [ViewHelper Reference](Documentation/ViewHelperReference.md).
<my:myComponent someParameter="someValue" />
```

6. Check out [Fluid Styleguide](https://github.com/sitegeist/fluid-styleguide), a living styleguide for Fluid Components

## Extended Documentation

* [ViewHelper Reference](Documentation/ViewHelperReference.md)
Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
"issues": "https://github.com/sitegeist/fluid-components/issues"
},
"require": {
"php": ">=7.2.0 <8",
"typo3/cms-core": "^9.5 || ^10.2",
"php": ">=7.2.0 <8"
"typo3fluid/fluid": "^2"
},
"require-dev": {
"typo3/testing-framework": "^4.0",
Expand Down

0 comments on commit 52d5d6a

Please sign in to comment.