Create your first file to get started.
Need a hand? Check out our documentation.
### Installing Pink Design CSS Library via NPM Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/getting-started.mdx This command installs the Pink Design CSS library as an NPM package, making it available in the project's node_modules directory. This is the standard method for integrating Pink Design into JavaScript-based projects. ```bash npm install "@appwrite.io/pink" ``` -------------------------------- ### Importing Pink Design CSS Library in JavaScript Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/getting-started.mdx After installing Pink Design via NPM, this JavaScript snippet shows how to import the CSS library and its optional icons into your project's JavaScript files. This ensures the styles are applied when the application runs. ```javascript import "@appwrite.io/pink"; // optionally, add icons import "@appwrite.io/pink-icons"; ``` -------------------------------- ### Common Astro Project Commands Source: https://github.com/appwrite/pink/blob/main/apps/pink/README.md This section lists essential `npm` commands for managing an Astro project. These commands cover installing dependencies, starting a local development server, building the production site, previewing the build, and general usage of the Astro command-line interface. ```Shell npm install npm run dev npm run build npm run preview npm run astro ... npm run astro --help ``` -------------------------------- ### Including Pink Design CSS Library via CDN in HTML Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/getting-started.mdx This snippet demonstrates how to include the Pink Design CSS library and optionally its icons into an HTML project by adding tags within the
section of the HTML file. This method is suitable for quick integration without a build step. ```html ``` -------------------------------- ### Installing Pink Design via NPM Source: https://github.com/appwrite/pink/blob/main/README.md This command installs the Pink Design CSS library using npm, making it available for use in your project. It's the recommended method for projects using a package manager. ```bash npm install "@appwrite.io/pink" ``` -------------------------------- ### Installing Pink Design via NPM Source: https://github.com/appwrite/pink/blob/main/packages/ui/README.md This command installs the Pink Design CSS library as a package using npm. It's the first step to integrate Pink Design into a JavaScript project, making the library available for import and use. ```bash npm install "@appwrite.io/pink" ``` -------------------------------- ### SCSS Partial Example with Responsive Padding Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/foundations/responsive.mdx This snippet provides an example of an SCSS partial, demonstrating how to apply responsive padding to an element. It sets a default padding for all screen sizes and then overrides it for medium and larger screens using the $break2open variable, showcasing a practical application of responsive design. ```html ``` -------------------------------- ### Setting Up Pink Design Development Environment Source: https://github.com/appwrite/pink/blob/main/CONTRIBUTING.md This shell script provides the necessary commands to set up the Pink Design development environment. It clones the repository, navigates into the project directory, and installs all required Node.js dependencies using npm. ```Shell git clone https://github.com/appwrite/pink.git cd pink npm install ``` -------------------------------- ### Example Branch Naming Convention Source: https://github.com/appwrite/pink/blob/main/CONTRIBUTING.md This snippet provides an example of the recommended branch naming convention for contributions to Pink Design. It follows the format `TYPE-ISSUE_ID-DESCRIPTION`, illustrating how to combine the change type, issue number, and a brief description. ```Shell doc-548-submit-a-pull-request-section-to-contribution-guide ``` -------------------------------- ### Installing Pink Design Icons (NPM, Bash) Source: https://github.com/appwrite/pink/blob/main/packages/icons/README.md This `npm install` command adds the `@appwrite.io/pink-icons` package to your project's dependencies. It's the recommended method for integrating the icon library into JavaScript-based applications, making the icons available for import and use. ```bash npm install "@appwrite.io/pink-icons" ``` -------------------------------- ### Markdown Example for Comparison Directive Source: https://github.com/appwrite/pink/blob/main/CONTRIBUTING.md This Markdown snippet demonstrates the usage of custom directives like `COMPARISON`, `IMG`, `DO`, and `DONT` within Pink Design documentation. These directives are used to display best practices, showing both correct ('DO') and incorrect ('DONT') examples with associated images and descriptions. ```Markdown ::::COMPARISON ::IMG[/images/button-do-1.png, description] :::DO Increase recognition by using icons with universal meaning. Increase readability by keeping text short and using uppercase letter only for the first word. ::: ::IMG[/images/button-dont-1.png, description] :::DONT Avoid using specific icons, uppercase in every word and long sentences. ::: :::: ``` -------------------------------- ### Creating a Basic Drop List (Default Alignment) - HTML Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/components/drop-list.mdx This HTML snippet demonstrates a basic drop list with default alignment (block start + inline start). It includes a button to trigger the drop list and a section containing two list items, each with a button. ```HTMLNeed a hand? Check out our documentation.
I'm visible on mobile
I'm visible on tablets
I'm visible on desktop
I'm visible on tablets & desktops
I'm visible on mobile & tablets
``` -------------------------------- ### Auto Inline Start Margin with SCSS Utility Class Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/utilities/box-model.mdx This SCSS utility class applies `margin-inline-start: auto` to an element, used for pushing an element to the end of its inline direction within a flex or grid container. ```SCSS margin-inline-start: auto !important; ``` ```CSS margin-inline-start: auto !important; ``` -------------------------------- ### Implementing a Selectable Free Plan Card in HTML Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/components/label-card.mdx This HTML snippet demonstrates a selectable 'Free plan' card, similar to the Pro plan, but highlighting its 'Totally free' nature. It uses a label, radio input, and utility classes for layout and styling, providing a clear visual representation of a free tier option. ```HTML ``` -------------------------------- ### Applying Info State to Inline Tag - HTML Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/elements/inline-tag.mdx This example shows how to apply the `is-info` class to an inline tag, which typically renders it with a blue color, indicating an informational state. This is useful for highlighting specific counts or labels. ```html 2 ``` -------------------------------- ### Basic HTML Switch Implementation Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/elements/switch.mdx This snippet demonstrates the basic implementation of HTML switches using checkbox inputs with the 'switch' class. It shows both an unchecked and a checked switch, illustrating the default appearance and functionality. ```HTML ``` -------------------------------- ### Basic Collapsible List HTML Source: https://github.com/appwrite/pink/blob/main/apps/pink/src/pages/components/collapsible.mdx This HTML snippet demonstrates a basic implementation of a collapsible list using `ul`, `li`, `details`, `summary`, and `div` elements. Each `collapsible-item` contains a `collapsible-wrapper` with a `collapsible-button` (summary) and `collapsible-content`. ```HTMLCollapsibles are used to display a vertical list of headers that reveal or hide content. They allow to progressively disclose information as desired.
Collapsibles are used to display a vertical list of headers that reveal or hide content. They allow to progressively disclose information as desired.
Collapsibles are used to display a vertical list of headers that reveal or hide content. They allow to progressively disclose information as desired.
Preview not available