@trackunit/css-tailwind 0.0.1-alpha-59a0a75488.0

package/README.md

@@ -0,0 +1,20 @@
+> **⚠️ Beta**
+>
+> This is a beta version and subject to change without notice.
+
+# Trackunit CSS Tailwind
+
+This package exposes the Trackunit Tailwind configuration.
+The Tailwind configuration from this package is used by the Trackunit Manager as well as the Iris App SDK.
+
+Our custom Theme is defined by the Tailwind configuration tailwind-base.generated.js.
+
+Trackunit Iris Apps are used by external developers to integrate custom functionality into [the Trackunit Manager platform](https://www.trackunit.com/services/manager/).  
+
+For more info and a full guide on Iris App SDK Development, please visit our [Developer Hub](https://developers.trackunit.com/).
+
+## Trackunit
+This package was developed by Trackunit ApS.
+Trackunit is the leading SaaS-based IoT solution for the construction industry, offering an ecosystem of hardware, fleet management software & telematics.
+
+![The Trackunit logo](https://trackunit.com/wp-content/uploads/2022/03/top-logo.svg)

package/index.cjs

@@ -0,0 +1,2 @@
+'use strict';
+

package/lib/animations.d.ts

@@ -0,0 +1,6 @@
+import { Config } from "tailwindcss";
+/**
+ * A Partial tailwind config object to hold our custom animations.
+ * If you want a custom animation that should be available in the Manager as well as Iris Apps add it here.
+ */
+export declare const animations: Config["theme"];

package/lib/grids.d.ts

@@ -0,0 +1,6 @@
+import { Config } from "tailwindcss";
+/**
+ * A Partial tailwind config object to hold our custom grids.
+ * If you want a custom grid that should be available in the Manager as well as Iris Apps add it here.
+ */
+export declare const grids: Config["theme"];

package/lib/tailwind-base.d.ts

@@ -0,0 +1,3 @@
+import { Config } from "tailwindcss";
+declare const tailwindBaseConfig: Config;
+export default tailwindBaseConfig;

package/lib/utilities.d.ts

@@ -0,0 +1,44 @@
+import "@trackunit/css-core";
+/**
+ * Gets the value of a color from the css custom properties TailwindCSS theme.
+ * Looks in `theme.css` and `tailwind-custom-properties.css`.
+ *
+ * @param {string} customProperty The property name
+ * @returns {string} The value of the color "RRR GGG BBB" or "unknown value" if the color is not found.
+ */
+export declare function getColorValueFromCSSVariable(customProperty: string): string;
+/**
+ * A function to handle the tailwind opacity value for custom colors.
+ * Source: https://tailwindcss.com/docs/customizing-colors#using-css-variables
+ *
+ * @param {string} variable - The name of the css custom property.
+ * @returns {string} RGB color value and a comment with the actual value for the TailwindCSS Extension.
+ */
+export declare function withOpacityValue(variable: string): ({ opacityValue }: {
+    opacityValue?: string | undefined;
+}) => string;
+/**
+ * Returns an object with the color values for the TailwindCSS configuration.
+ *
+ * @param {string} colorName the name of the color
+ * @param {string} keys Default: ["50", "100", "200", "300", "400", "500", "600", "700", "800", "900"]
+ * @returns {*} An object with each of the keys and the corresponding color css custom property.
+ */
+export declare function fullColorSchemeFromColorName(colorName: string, keys?: string[]): {};
+/**
+ * Get the value of a custom property from a css file.
+ *
+ * @param customProperty - The name of the css custom property.
+ * @param file A string representing the file contents of the css file.
+ * @returns {string} A string representing the value of the css custom property or "unknown value" if the custom property is not found.
+ */
+export declare function getValueOfCSSCustomProperty(customProperty: string, file: string): string;
+/**
+ * Returns the css custom property with a comment containing the actual value of the custom property.
+ *
+ * @param {string} customProperty - The name of the css custom property.
+ * @param {string} [append=""] - A string to append to the comment.
+ * @param {*} [file=tailwindTheme] Default: tailwind-custom-properties.css
+ * @returns {string} A string representing the css custom property with a comment containing the actual value of the custom property.
+ */
+export declare function withCustomPropertyValueAsComment(customProperty: string, append?: string, file?: string): string;

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@trackunit/css-tailwind",
+  "version": "0.0.1-alpha-59a0a75488.0",
+  "main": "./index.cjs",
+  "repository": "https://github.com/Trackunit/manager",
+  "license": "SEE LICENSE IN LICENSE.txt",
+  "type": "commonjs",
+  "types": "./index.d.ts",
+  "dependencies": {
+    "@trackunit/ui-design-tokens": "0.0.47"
+  },
+  "peerDependencies": {}
+}