Close Menu

cluikit

Welcome to the documentation for the Cluikit framework! Cluikit is a powerful toolkit designed to enhance the user interface development experience on iOS and macOS applications. It provides a wide range of components and utilities that can be seamlessly integrated into your projects to create beautiful and engaging interfaces. This documentation will guide you through the installation, usage, and customization of Cluikit.

Getting Started

Installation

To integrate Cluikit into your project, follow these steps:

  1. Open your project in Xcode.
  2. Navigate to the File menu and select Swift Packages > Add Package Dependency.
  3. In the repository URL field, enter https://github.com/cluikit/cluikit.git and click Next.
  4. Select the desired version or branch of Cluikit and click Next.
  5. Choose the desired target for Cluikit, then click Finish.
  6. Wait for Swift Package Manager to resolve and fetch the Cluikit package.
  7. In your project’s target, navigate to General > Frameworks, Libraries, and Embedded Content.
  8. Add Cluikit.framework and set its Status to Required.

Usage

Once Cluikit is successfully integrated into your project, follow these steps to start using it:

  1. Add import Cluikit at the top of your source file.
  2. Explore the various components and utilities provided by Cluikit and choose the ones that fit your requirements.
  3. Refer to the relevant sections in this documentation for detailed usage instructions and examples.

Customization

Cluikit allows you to customize its components and utilities to suit your application’s visual style and branding. Follow the instructions below to customize Cluikit:

  1. Create a new subclass or extension for the desired Cluikit component.
  2. Override the relevant properties and methods to customize the appearance and behavior.
  3. Refer to the customization examples provided in the documentation for guidance.

Components

Buttons

Cluikit provides a range of pre-styled buttons that can be easily integrated into your application. You can choose from:

  • Primary Button
  • Secondary Button
  • Outline Button
  • Destructive Button

Each button style has its own set of properties and usage guidelines. Refer to the relevant sections in this documentation to learn more about each button type and how to use them effectively in your interface.

Text Fields

Cluikit offers a variety of text field styles to collect user input. You can choose from:

  • Regular Text Field
  • Secure Text Field

Learn how to integrate and customize these text field styles by referring to the dedicated sections in this documentation.

Utilities

Colors

Cluikit provides a set of predefined colors that can be used to maintain a consistent visual style throughout your application. Utilize the color utility guide to find the available colors and how to use them effectively.

Typography

Cluikit defines a set of typography styles that you can utilize to ensure consistent and visually appealing text throughout your application. The typography utility guide explains the available styles and their appropriate usage.

Icons

Cluikit offers a collection of icons that can enhance the visual appeal and usability of your application. The icon utility guide provides a comprehensive list of available icons and how to integrate them into your user interface.

Spacing

The spacing utility guide outlines the recommended spacing guidelines to keep a balanced and visually pleasing layout in your application. Use these guidelines to ensure proper alignment and breathing space between different UI elements.

Helpers

A set of helper utilities is provided by Cluikit to simplify common tasks and enhance the development process. These utilities assist in tasks such as layout management, animations, and common calculations. The helper utility guide explains each utility and provides examples of their usage.

Conclusion

Congratulations on successfully acquainting yourself with Cluikit, the powerful user interface development toolkit! With Cluikit, you can create visually stunning and engaging interfaces for your iOS and macOS applications. Feel free to explore the detailed documentation for each component and utility to unlock the full potential of Cluikit in your projects.