carbon / eel
Some nice Eel helper for Neos.io
Fund package maintenance!
jonnitto
www.paypal.me/Jonnitto/20eur
Installs: 226 982
Dependents: 30
Suggesters: 0
Security: 0
Stars: 7
Watchers: 4
Forks: 2
Open Issues: 0
Type:neos-carbon
Requires
- php: ^8.1
- behat/transliterator: ^1.2
- gehrisandro/tailwind-merge-php: ^1.0
- matthiasmullie/minify: ^1.3
- neos/flow: ^7.0 || ^8.0 || ^9.0
- dev-master
- 2.16.1
- 2.16.0
- 2.15.2
- 2.15.1
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.1
- 2.2.0
- 2.1.0
- 2.0.0
- v1.x-dev
- 1.13.3
- 1.13.2
- 1.13.1
- 1.13.0
- 1.12.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.3
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.1
- 1.5.0
- 1.4.1
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.1
- 1.1.0
- 1.0.0
- 0.5.2
- 0.5.1
- 0.5.0
- dev-old_namespace
This package is auto-updated.
Last update: 2024-11-14 13:28:43 UTC
README
Carbon.Eel Package for Neos CMS
BEM Helper
Generates BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']
), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and a value is true
, the key's name gets used for the modifier.
block
(string, required) The name of the blockelement
(string) The name of the element, optionalmodifiers
(string|array) The name of the modifiers, optional
BEM.array(block, element, modifiers)
Shortcut to Carbon.Array.BEM(block, element, modifiers)
BEM.string(block, element, modifiers)
Shortcut to Carbon.String.BEM(block, element, modifiers)
BEM.modifier(class, modifiers)
Generates a string with BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']
), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and the value is true
, the key's name gets used for the modifier.
class
(string, required) The name of the classmodifiers
(string|array) The name of the modifiers, optional
Return The string
Array Helper
Carbon.Array.BEM(block, element, modifiers)
Generates an array with BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']
), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and the value is true
, the key's name gets used for the modifier.
block
(string, required) The name of the blockelement
(string) The name of the element, optionalmodifiers
(string|array) The name of the modifiers, optional
Return The array
Carbon.Array.chunck(array, length, preserveKeys)
Chunks an array into arrays with length
elements. The last chunk may contain less than length
elements.
array
(array, required) The array to work onlength
(integer, required) The size of each chunkpreserveKeys
(bool) When set totrue
, keys will be preserved. Default isfalse
, which will reindex the chunk numerically
Carbon.Array.join(array, separator)
Join the given array recursively using the given separator.
${Carbon.Array.join(array, ',')}
array
(array) The array that should be processedseparator
(string, optional) The separator between the values defaults to,
Return The converted array as a string
Carbon.Array.extractSubElements(array, preserveKeys)
This method extracts sub-elements to the parent level.
An input array of type:
[
element1 => [
0 => 'value1'
],
element2 => [
0 => 'value2'
1 => 'value3'
],
will be converted to:
[
0 => 'value1'
1 => 'value2'
2 => 'value3'
]
array
(array) The array that should be processedpreserveKeys
(boolean, optional) Option if the key should be preserved, defaults tofalse
Return The converted array
Carbon.Array.intersect(array1, array2, array_)
array1
(iterable|mixed) First array or valuearray2
(iterable|mixed) Second array or valuearray_
(iterable|mixed, optional) Optional variable list of additional arrays / values
Returns an array containing all the values of array1
that are present in all the arguments.
Carbon.Array.length(array)
The method counts elements of a given array or a countable object. Return 0
if it is not an countable object.
count = ${Carbon.Array.length(countable)}
Carbon.Array.hasKey(array, key)
Returns a boolean if the array has a specific key
bool = ${Carbon.Array.hasKey(array, key)}
Carbon.Array.hasValue(array, value)
Returns a boolean if the array has a specific value
bool = ${Carbon.Array.hasValue(array, value)}
Carbon.Array.getValueByPath(array, path)
Returns the value of a nested array by following the specified path.
value = ${Carbon.Array.getValueByPath(array, path)}
Carbon.Array.setValueByPath(array, path, value)
Sets the given value in a nested array or object by following the specified path.
array = ${Carbon.Array.setValueByPath(subject, path, value)}
Carbon.Array.check(variable)
Check if a variable is iterable and has items
Return The variable or null
if it is empty or not an iterable
Carbon.Array.isCountable(variable)
Check if the given variable is countable
Return true
or false
Carbon.Array.sortByItem(array, key, direction)
array
(iterable|mixed) array with arrays to sortkey
(string) Key of array to sortdirection
(string, optional)ASC
orDESC
. Direction of sorting
Return The sorted array
Date Helper
Carbon.Date.secondsUntil(string)
Return seconds until the given offset. . Very useful for maximumLifetime
on the @cache
entry.
string
(string) The offset inDateInterval
format starting from midnightdateinerval
(boolean, optional) true if interval should be used or the $offset should be parsed, defaults totrue
In this example, we clear the cache at midnight by adding an offset of 0 hours.
@cache { mode = 'cached' maximumLifetime = ${Carbon.Date.secondsUntil('PT0H')} ... }
To get the seconds until next year, you can do it like this:
secondUntilNextYear = ${Carbon.Date.secondsUntil('first day of January next year', false)}
Return The timespan in seconds (integer)
Carbon.Date.timeToDateInterval(string)
Convert time duration (1:00) into a DateInterval
Return The duration as DateInterval
FileContent Helper
Carbon.FileContent.path(string)
Returns the file content of a path. Fails silently.
Examples:
Carbon.FileContent.path('resource://Foo.Bar/Private/Assets/Logo.svg') Carbon.FileContent.path('Foo.Bar/Private/Assets/Logo.svg')
string
(string) The path to the file
Return The content of the file
Carbon.FileContent.pathHash(string, length)
Returns the hash value from the file content of a path. Fails silently.
Examples:
Carbon.FileContent.pathHash('resource://Foo.Bar/Private/Assets/Logo.svg') == 1d62f5a5 Carbon.FileContent.pathHash('Foo.Bar/Private/Assets/Logo.svg', 20) == 1d62f5a55ad5e304d60d
string
(string) The path to the filelength
(integer, optional) The length of the hash value defaults to8
. The maximal value is40
Return The hash value from the content of the file
Carbon.FileContent.resource(resource)
Returns the file content of a persisted resource. Fails silently.
Example:
Carbon.FileContent.resource(q(node).property('file'))
resource
(resource) The persisted resource to read
Return The content of the file
Carbon.FileContent.resourceHash(resource, length)
Returns the hash value from the file content of a persisted resource. Fails silently.
Example:
resource
(resource) The persisted resource to readlength
(integer, optional) The length of the hash value defaults to8
. The maximal value is40
Return The hash value from the content of the file
Tailwind Helper
Tailwind.merge(mixed1, mixed2, mixedN)
This helper allows you to merge multiple Tailwind CSS classes and automatically resolves conflicts between them without headaches. Render all arguments as classNames and apply conditions if needed. Merge strings and arrays to a string with unique values, separated by an empty space.
All arguments of the eel helper are evaluated and the following rules are applied:
- falsy values: (
null
,''
,[]
,{}
) are not rendererd - array: all items that are scalar and truthy are rendered as classname
- object: keys that have a truthy values are rendered as classname
- scalar: is cast to string and rendered as class-name
It is based on tailwind-merge-php.
Examples:
Return The merged string
Configuration
If you are using Tailwind CSS without any extra config, you can use the Eel helper right away. And stop reading here.
If you're using a custom Tailwind config, you may need to configure the Eel helper as well to merge classes properly.
By default it is configured in a way that you can still use it if all the following apply to your Tailwind config:
- Only using color names which don't clash with other Tailwind class names
- Only deviating by number values from number-based Tailwind classes
- Only using font-family classes which don't clash with default font-weight classes
- Sticking to default Tailwind config for everything else
If some of these points don't apply to you, you need to customize the configuration.
This is an example to add a custom font size of very-large
:
Carbon: Eel: tailwindMergeConfig: classGroups: 'font-size': - text: ['very-large']
You can also enable different validators, to make everything easier. For instance, if you use the Tailwind OKLCH Plugin, you can set it like that:
Carbon: Eel: tailwindMergeConfig: classGroups: 'fill-lightness': - 'fill-lightness-offset': ['INTEGER_VALIDATOR', 'ARBITRARY_NUMBER_VALIDATOR'] 'border-lightness': - 'border-lightness-offset': ['INTEGER_VALIDATOR', 'ARBITRARY_NUMBER_VALIDATOR'] 'text-lightness': - 'text-lightness-offset': ['INTEGER_VALIDATOR', 'ARBITRARY_NUMBER_VALIDATOR'] 'bg-lightness': - 'bg-lightness-offset': ['INTEGER_VALIDATOR', 'ARBITRARY_NUMBER_VALIDATOR']
If you want to use a certain validator, just change it to constant case and add it as a string.
So, for examle, if you want to use the TshirtSizeValidator
, just add TSHIRT_SIZE_VALIDATOR
to the list.
The merge service uses a its own cache
Carbon_Eel_Tailwind
. Make sure to clear the cache when you are making changes to the configuration.
AlpineJS Helper
AlpineJS.object(arg1, arg2, ..argN)
Generate an object for AlpineJS directive x-data
.
Supports nested arrays. You could do the same with Json.stringify()
, but this function is shorter, as AlpineJS
accepts objects and easier to write and read. The default magics from Alpine.js will not be converted to string. The
same goes with methods (see example below).
Examples:
Of course you can also pass DataStructures
to the helper:
prototype(Foo.Bar:Example) < prototype(Neos.Fusion:Component) { data = Neos.Fusion:DataStructure { effect = 'slide' spaceBetween = 12 persistedNumber = '$persist(5)' 'log(value)' = '{console.log(value)}' } renderer = ${AlpineJS.object(props.data)} }
...arguments
The array
Return The JavaScript object as string
AlpineJS.function(name, arg1, arg2, ..argN)
Generate a function call for AlpineJS. More info.
Supports nested arrays. In named arrays ({first:1,second:null}
) null
get filtered out, but in list
arrays ([1,null]
) and in plain values the will stay. Basically it is the same as AlpineJS.object
, just wrapped in a
function call.
Examples:
name
(string) The name for the function (e.gx-data
,x-on:click
, etc.)...arguments
(mixed) The options for the function
Return The string for the x-data function call
AlpineJS.magic(name, arg1, arg2, ..argN)
Generate a call for a magic function for AlpineJS..
Supports nested arrays. In named arrays ({first:1,second:null}
) null
get filtered out, but in list
arrays ([1,null]
) and in plain values the will stay.
Examples:
name
(string) The name for the magic. If not prefixed with an$
, it will automatically prefixed....arguments
(mixed) The options for the function
Return The string for the magic function call
AlpineJS.expression(value)
Use this to pass a javascript expression inside of the AlpineJS.object
, AlpineJS.function
or AlpineJS.magic
helper
Examples:
String Helper
Carbon.String.BEM(block, element, modifiers)
Generates a string with BEM classes. The modifiers property can be a string (for one modifier), an array (e.g. ['one', 'two']
), or an array with keys and values. If you have an array with keys and values (like a Fusion DataStructure) and the value is true
, the key's name gets used for the modifier.
block
(string, required) The name of the blockelement
(string) The name of the element, optionalmodifiers
(string|array) The name of the modifiers, optional
Return The string
Carbon.String.getPropertyFromNodeLink(node, value, propertyName, fallback)
Get a property from a node link. Can be used to get the title from a page who is linked via the link editor.
Example:
node
(NodeInterface) The node, usallysite
value
(string) The value to processpropertyName
(string) The name of the property to getfallback
(mixed) The fallback value if nothing is found
Carbon.String.urlize(string)
Generates a slug of the given string
Examples:
string
(string) The string to convert
Return The converted string
Carbon.String.minifyJS(javascript)
Minifies JavaScript so that it can be delivered to the client quicker.
javascript
(string, required) The JavaScript to minify
Return The minified JavaScript
Carbon.String.minifyCSS(javascript)
Minifies CSS so that it can be delivered to the client quicker.
css
(string, required) The CSS to minify
Return The minified CSS
Carbon.String.toPascalCase(string)
Convert strings to PascalCase
.
Examples:
string
(string) The string to convert
Return The converted string
Carbon.String.toCamelCase(string)
Convert strings to camelCase
.
Examples:
string
(string) The string to convert
Return The converted string
Carbon.String.convertCamelCase(string, separator)
Convert CamelCaseStrings
to hyphen-case-strings
Examples:
string
(string) The string to convertseparator
(string, optional) The separator between the words defaults to-
Return The converted string
Carbon.String.convertToString(input, separator)
Helper to make sure to get a string back.
Examples:
input
(string, array) A string or an array to convertseparator
(string, optional) The separator between the words, defaults to whitespace
Return The converted string
Carbon.String.nl2br(string, separator)
Replace all newlines with an <br>
.
Examples:
string
(string) A string to convertseparator
(string, optional) The separator between the words, defaults to<br>
Return The converted string
Carbon.String.removeNbsp(string)
Replace non-breaking spaces and double spaces with a normal space.
Examples:
string
(string) A string to convert
Return The converted string
Carbon.String.classNames(mixed1, mixed2, mixedN)
Render all arguments as classNames and apply conditions if needed. Merge strings and arrays to a string with unique values, separated by an empty space.
All arguments of the eel helper are evaluated and the following rules are applied:
- falsy values: (
null
,''
,[]
,{}
) are not rendererd - array: all items that are scalar and truthy are rendered as classname
- object: keys that have a truthy values are rendered as classname
- scalar: is cast to string and rendered as class-name
Examples:
Return The merged string
Carbon.String.splitIntegerAndString(string)
Split a string into an array width integers and strings. Useful for animations.
Examples:
string
(string) The string to split
Return The string, splitted into an array of integers and strings
Carbon.String.phone(phoneNumber, defaultCountryCode, prefix)
Helper to convert phone numbers to a compatible format for links
Examples:
phoneNumber
(string) The phone number to convertdefaultCountryCode
(string, optional) The default country code, for example'+41'
prefix
(string, optional) Prefix the phone number, defaults to'tel:'
Return The phone number, optimized for links
Carbon.String.isValidEmail(emailAddress)
Checks if the string is a valid email address
Examples:
emailAddress
(string) The string to check
Carbon.String.replaceOnce(string, search, replace)
Helper to replace the first occurrence of a string.
Examples:
string
(string) The string being searched and replaced onsearch
(string) The value being searched forprefix
(string, optional) The replacement value that replaces found search value
Returns the string with one occurrence replaced
Number Helper
Carbon.Number.format(number, decimals, dec_point, thousands_sep)
Format a number with grouped thousands. If decimals
is set to null
, it returns as many as needed decimals.
number
(float, required) The number being formatteddecimals
(integer, optional) Sets the number of decimal points, defaults tonull
dec_point
(string, optional) The name of the modifier defaults to.
thousands_sep
(string, optional) The name of the modifier defaults to,
Carbon.Number.formatLocale(number, decimals, locale)
Format a localized number with grouped thousands. If decimals
is set to null
, it returns as many as needed decimals.
number
(float, required) The number being formatteddecimals
(integer, optional) Sets the number of decimal points, defaults tonull
locale
(string, optional) String locale - example (de_DE|en|ru_RU)
Carbon.Number.decimalDigits(number)
Get number of decimal digits.
number
(float, required) The number being formatted
Carbon.Number.pxToRem(value, fallback)
Convert a pixel value to rem
value
(numeric | string, required) The value to convertedfallback
(numeric | string, optional) Fallback value ifvalue
isfalse
ornull
Examples:
Returns a string with the converted value
Backend Helper
Carbon.Backend.language()
Returns the language from the interface
Carbon.Backend.translate(id, originalLabel, arguments, source, package, quantity, locale)
Get the translated value (in the language of the interface) for an id or original label. If the only id is set and contains a translation shorthand string, translate according to that shorthand.
In all other cases: Replace all placeholders with corresponding values if they exist in the translated label.
id
(string) Id to use for finding translation (trans-unit id in XLIFF)originalLabel
(string, optional) The original translation value (the untranslated source string)arguments
(array, optional) Array of numerically indexed or named values to be inserted into placeholderssource
(string, optional) Name of file with translationspackage
(string, optional) Target package keyquantity
(mixed, optional) A number to find a plural form for (float or int),null
to not use plural formslocale
(string, optional) An identifier of the locale to use (NULL for use the interface language)
Returns the translated label or source label / ID key
Installation
Carbon.Eel is available via packagist. Just run
composer require carbon/eel
Credits
Some of the Eel helpers were inspired and or copied from punkt.de