Giter Club home page Giter Club logo

linkzy's Introduction

Linkzy Logo

Linkzy
Unstyled components for create your own link-in-bio page.

Introduction

An open-source collection of unstyled components for create your link-in-bio using React, Vue (soon) and Svelte (soon). Say goodbye to generic page designs and stand out from the crowd. Linkzy empowers you to fully customize your link-in-bio according to your preferences.

Install

Install one of the components from your command line.

With yarn

yarn add @linkzy/react -E

With npm

npm install @linkzy/react -E

With pnpm

pnpm install @linkzy/react -E

Getting Started

Add the component to your template. Include styles where needed.

import * as Linkzy from '@linkzy/react';

const Template = () => {
  return (
    <Linkzy.Root>
      <Linkzy.Head>
        <Linkzy.Avatar>
          <img src="..." />
        </Linkzy.Avatar>
        <Linkzy.Content>
          <Linkzy.Title label="Javier Diaz" />
          <Linkzy.Bio>A software engineer who designs</Linkzy.Bio>
        </Linkzy.Content>
      </Linkzy.Head>
      <Linkzy.Group>
        <Linkzy.Link
          href="https://youtube.com/@coderdiaz"
          label="Visita mi canal de Youtube"
        />
        <Linkzy.Link
          href="https://twitch.tv/coderdiaz"
          label="Visita mi canal de Twitch"
        />
        <Linkzy.Link
          href="https://coderdiaz.dev/contacto"
          label="Ponte en contacto conmigo"
        />
      </Linkzy.Group>
    </Linkzy.Root>
  );
};

Authors

License

Licensed under the MIT License. See LICENSE for more information.

Copyright © 2023 Javier Diaz Chamorro

linkzy's People

Contributors

coderdiaz avatar

Watchers

 avatar

Forkers

maikcyphlock

linkzy's Issues

Add support for Storybook

Please describe your request or idea
A clear and concise description. Ex. I'm always frustrated when [...]

We need to add support for using a storybook to test our components.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Additional context
Add any other context or screenshots about the feature request here.

Add support for default themes

Please describe your request or idea
A clear and concise description. Ex. I'm always frustrated when [...]

Currently, the components are unstyled by default but if any wants to start using the package fast the user requires at least 2 themes ready to use:

  • Minimal.
  • Neo-brutal.

Describe the solution you'd like
A clear and concise description of what you want to happen.

We can follow the steps of the Radix Themes project to offer this functionality without so much hassle.

Additional context
Add any other context or screenshots about the feature request here.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.