{"id":19114835,"url":"https://github.com/namelesscoder/patternlab-fluid-edition","last_synced_at":"2025-06-17T05:03:53.235Z","repository":{"id":57023485,"uuid":"110622226","full_name":"NamelessCoder/patternlab-fluid-edition","owner":"NamelessCoder","description":"Pattern Lab Fluid Edition","archived":false,"fork":false,"pushed_at":"2018-01-18T21:26:25.000Z","size":970,"stargazers_count":19,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-16T08:07:29.988Z","etag":null,"topics":["atomic-design","design","fluid","neos-cms","pattern-lab","patternlab","typo3"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NamelessCoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-11-14T01:07:53.000Z","updated_at":"2023-12-12T16:27:55.000Z","dependencies_parsed_at":"2022-08-23T13:51:06.310Z","dependency_job_id":null,"html_url":"https://github.com/NamelessCoder/patternlab-fluid-edition","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/NamelessCoder/patternlab-fluid-edition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Fpatternlab-fluid-edition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Fpatternlab-fluid-edition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Fpatternlab-fluid-edition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Fpatternlab-fluid-edition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NamelessCoder","download_url":"https://codeload.github.com/NamelessCoder/patternlab-fluid-edition/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NamelessCoder%2Fpatternlab-fluid-edition/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260294454,"owners_count":22987622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["atomic-design","design","fluid","neos-cms","pattern-lab","patternlab","typo3"],"created_at":"2024-11-09T04:44:39.449Z","updated_at":"2025-06-17T05:03:53.215Z","avatar_url":"https://github.com/NamelessCoder.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Pattern Lab Fluid Edition\n=========================\n\n**This is the entry point for new Pattern Lab Fluid Edition projects!**\n\n![license](https://img.shields.io/github/license/namelesscoder/patternlab-fluid-edition.svg)\n![Packagist](https://img.shields.io/packagist/v/namelesscoder/patternlab-fluid-edition.svg)\n\n# Pattern Lab Fluid Edition\n\nThis package is an edition of [Pattern Lab](http://patternlab.io) for the [TYPO3 Fluid template engine](https://github.com/TYPO3/Fluid). \n\n## Installing\n\n**Please note:** The Pattern Lab Fluid edition exclusively uses [Composer](https://getcomposer.org/) to manage project dependencies.\nNo pre-built packages are available - the application can only be installed with Composer.\n\n### Use Composer to create a project\n\nPattern Lab uses [Composer](https://getcomposer.org/) to manage project dependencies.\n\n#### 1. Install Composer\n\nPlease follow the directions for [installing Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) on the Composer website.\n\n#### 2. Install the Pattern Lab Fluid Edition\n\nUse Composer's [`create-project` command](https://getcomposer.org/doc/03-cli.md#create-project) to install the edition as base for new projects:\n\n    cd install/location/\n    composer create-project namelesscoder/patternlab-fluid-edition your-project-name \u0026\u0026 cd $_\n\nThis will create a folder named `your-project-name`, install the Fluid edition to that folder and walk you through the install process.\n\nYou will be asked to choose a starter kit - at the current time only one such starter kit is available. Select and install it to complete the installation process. \n\n## Updating Pattern Lab\n\nUpdating the Fluid edition of Pattern Lab can be done with `composer update`.\n\n\n## Special usage instructions for Fluid\n\nThe Pattern Lab Fluid Edition comes with a few extra features as demonstrated by this configuration example:\n\n\u003e config/config.yml\n\n```yaml\nfluidNamespaces:\n    f:\n        - TYPO3\\CMS\\Fluid\\ViewHelpers\n    myns:\n        - My\\Package\\ViewHelpers\nemulatedViewHelpers:\n    My\\Special\\TagGeneratingViewHelper:\n        tagName: \"a\"\n        attributeMap:\n            specialTargetArgumentName: \"href\"\n        outputsTagContent: true\n        forceClosingTag: true\n    My\\Special\\NormalViewHelper:\n        outputsTagContent: true\n```\n\nBriefly described, these options allows:\n\n* Registering additional namespaces that Fluid will see (inline imports are still fully possible!)\n* Emulate ViewHelpers from packages which have special requirements e.g. for DB access\n\nThe ViewHelper emulation is only superficially configurable; generally speaking the best advise is to structure your\ntemplates so that things like URLs (which are usually framework-specific) do not get generated by ViewHelpers but are\ninstead passed as arguments to partials. But for those cases where a ViewHelper must be included and an output emulated,\nthese options can be used.\n\nThe options allow:\n\n* Changing the tag name of TagBasedViewHelpers.\n* Mapping arguments to attributes of resulting tags (e.g. your ViewHelper receives an ID as target, mapping that to\n  for example `href` will produce valid HTML - but with broken link targets).\n* Configure whether or not an emulated ViewHelper is designed to output the tag contents.\n* Forcing a generated tag to be self-closing or not (for example if the ViewHelper generates `\u003cscript\u003e` this must be set\n  to `false` to produce a `\u003cscript\u003e\u003c/script\u003e` tag instead of `\u003cscript /\u003e`).\n\nIt is also possible to create drop-in ViewHelpers by making new PHP class files in `source/_viewhelpers/` and using the\nspecial `plio` namespace, e.g. if you created a file `MySpecialViewHelper.php` with a class called `MySpeciaViewHelper`\nthen this class can be used as `\u003cplio:mySpecial /\u003e` in templates without needing to import the namespace.\n\nDrop-in ViewHelpers *can use completely arbitrary folder nesting and namespaces* which makes it easier to prototype such\nclasses without being able to autoload them through normal means, and without having a target package for them as is\nnormally required.\n\n### ViewHelper argument validation and execution\n\nThere are two levels of emulation which may apply to ViewHelpers:\n\n1. Original class is completely missing, which fully emulates the ViewHelper\n2. Original class exists but cannot be rendered, which only partially emulates the ViewHelper\n\nWhat this means is that *fully emulated* ViewHelpers do not validate arguments at all and will only behave as they are\nconfigured to behave using settings above. But, *partially emulated* ViewHelpers will validate arguments being used to\nverify that required arguments are present and will attempt to render themselves - but any failure while rendering\ncauses the emulated output to take over. For example, this can be failures stemming from missing dependencies or lack\nor an environment expected by the application the ViewHelper belongs to.\n\nIn short: if you wish ViewHelper arguments to be validated and those ViewHelpers which have no special dependencies to\nbe fully functional, make sure you also add the package providing these ViewHelpers as dependency for your local\nproject - and configure or import the namespace in templates. If the class can be loaded, argument descriptions can be\nloaded and validated as well.    \n\n## Helpful Commands\n\nThese are some helpful commands you can use on the command line for working with Pattern Lab.\n\n### List all of the available commands\n\nTo list all available commands type:\n\n    php core/console --help\n\nTo list the options for a particular command type:\n\n    php core/console --help --[command]\n\n### Generate Pattern Lab\n\nTo generate the front-end for Pattern Lab type:\n\n    php core/console --generate\n\n### Watch for changes and re-generate Pattern Lab\n\nTo watch for changes and re-generate the front-end for Pattern Lab type:\n\n    php core/console --watch\n\n### Start a server to view Pattern Lab\n\nYou can use PHP's built-in web server to review your Pattern Lab project in a browser. In a seperate window type:\n\n    php core/console --server\n\nThen open [http://localhost:8080](http://localhost:8080) in your browser.\n\n### Install a StarterKit\n\nTo install a near-empty StarterKit as a starting point for your project type:\n\n    php core/console --starterkit --init\n\nTo install a specific StarterKit from GitHub type:\n\n    php core/console --starterkit --install \u003cstarterkit-vendor/starterkit-name\u003e\n\n### Credits\n\nThis work was kindly sponsored by [Busy Noggin](http://busynoggin.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamelesscoder%2Fpatternlab-fluid-edition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnamelesscoder%2Fpatternlab-fluid-edition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnamelesscoder%2Fpatternlab-fluid-edition/lists"}