UF-Template

UF-Template is a project template designed to help you quickly set up and start developing your application. This template includes various utilities to streamline your development process.

Table of Contents

• Installation
• Getting Set Up
• Example Usage
• Dependencies
• License

Installation

To install the uf-template package, run:

npm install uf-template

Example Usage

The following example demonstrates how to use the Breadcrumbs component. This example applies to both JavaScript and TypeScript:

import { useState } from 'react';
import { Breadcrumbs } from 'uf-template';

const App = () => {
  const [currentPage, setCurrentPage] = useState('Sample Page');

  const handleClick = (item: string) => {
    if (item === 'Home') {
      setCurrentPage('Home');
    } else {
      setCurrentPage(item);
    }
  };

  return <Breadcrumbs items={['Home', 'Sample Module', 'Sample Page']} onClick={handleClick} />;
};

export default App;

Dependencies

You need to include the following dependencies in your project:

Download and include the master CSS file:

<link href="master.css" rel="stylesheet" type="text/css" />

Include the Webflow dependencies:

<script
  src="https://d3e54v103j8qbb.cloudfront.net/js/jquery-3.5.1.min.dc5e7f18c8.js?site=665515d66ae3ac9e19b76d10"
  type="text/javascript"
  integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0="
  crossorigin="anonymous"
></script>
<script src="/webflow.js" type="text/javascript"></script>

For more details on dependencies, visit Factory Docs.

License

This project is licensed under the MIT License.