Skip to content

vkop007/DecoProfile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

127 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

DecoProfile

DecoProfile Logo

DecoProfile

Profile Decoration Component Library

License: MIT Next.js TypeScript


DecoProfile is a comprehensive web interface and component library that brings the magic of Discord-style profile decorations to your web applications. Explore, preview, and implement stunning animated avatars, profile effects, and namespace decorations with ease.

✨ Features

  • 🎨 Extensive Library - browse hundreds of avatar decorations and profile effects.
  • ⚑️ Live Preview - Instantly preview how decorations look on different avatars and profiles.
  • πŸ› οΈ Component Library - Production-ready React components for easy integration.
  • πŸ“± Responsive Design - Fully responsive UI built with Tailwind CSS.
  • πŸ” Smart Search - Quickly find specific decorations by name or category.
  • πŸŒ™ Dark Mode - Native dark mode support for comfortable viewing.
  • πŸ’Ž TypeScript Support - Full type safety with autocomplete for decoration names.

πŸ› οΈ Tech Stack

πŸš€ Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

πŸ“¦ Usage

DecoProfile isn't just a showcase; it provides the decoprofile NPM package for your own projects.

npm install decoprofile

Quick Example

import {
  AvatarDecoration,
  ProfileDecoration,
  NamespaceDecoration,
} from "decoprofile";

function App() {
  const avatarUrl = "https://example.com/avatar.jpg";

  return (
    <div>
      {/* Avatar with animated decoration */}
      <AvatarDecoration name="Akuma" src={avatarUrl} size={160} />

      {/* Profile card with background effect */}
      <ProfileDecoration name="OnisCurse" src={avatarUrl}>
        <h2>Username</h2>
        <p>Premium User</p>
      </ProfileDecoration>

      {/* Namespace bar with video background */}
      <NamespaceDecoration name="Reddragon" src={avatarUrl} userName="Player" />
    </div>
  );
}

Browser Implementation (No React Required!)

Use DecoProfile directly in HTML without any build tools. Download the browser bundle:

πŸ‘‰ decoprofile.browser.js

<!DOCTYPE html>
<html>
  <head>
    <title>DecoProfile Demo</title>
  </head>
  <body>
    <div id="my-avatar"></div>
    <div id="my-profile"></div>

    <!-- Single script - includes React! -->
    <script src="decoprofile.browser.js"></script>

    <script>
      DecoProfile.render("#my-avatar", "Avatar", {
        name: "Aurora",
        src: "https://avatars.githubusercontent.com/u/124573409?v=4",
        size: 160,
      });
    </script>
  </body>
</html>

πŸ“š Components

AvatarDecoration

Adds animated decoration frames around user avatars.

<AvatarDecoration
  name="Akuma" // Decoration name (autocomplete available)
  src="/avatar.jpg" // User's avatar image URL
  size={160} // Size in pixels (default: 160)
  className="custom" // Optional CSS class
/>
Prop Type Default Description
name AvatarDecorationName required Decoration effect name
src string required User's avatar image URL
size number 160 Size in pixels
className string - Optional CSS class

ProfileDecoration

Creates profile cards with animated background effects.

<ProfileDecoration
  name="OnisCurse" // Effect name (autocomplete available)
  src="/avatar.jpg" // User's avatar image URL
  scale={1} // Scale multiplier (default: 1)
>
  <h2>Username</h2>
  <p>Status text</p>
</ProfileDecoration>
Prop Type Default Description
name ProfileDecorationName required Profile effect name
src string required User's avatar image URL
children ReactNode - Content below avatar
scale number 1 Scale multiplier (1 = 300px width)
className string - Optional CSS class

NamespaceDecoration

Animated namespace bars with video background effects.

<NamespaceDecoration
  name="Reddragon" // Namespace name (autocomplete available)
  src="/avatar.jpg" // User's avatar image URL
  userName="Player" // Display name
  scale={1} // Scale multiplier (default: 1)
>
Prop Type Default Description
name NamespaceDecorationName required Namespace effect name
src string - User's avatar image URL
userName string "User" Display name in the bar
scale number 1 Scale multiplier (1 = 260x52px)
className string - Optional CSS class

🎨 Available Decorations

DecoProfile includes a wide variety of decorations:

  • 334 Avatar decoration effects
  • 84 Namespace decoration effects
  • 116 Profile background effects

All decoration names provide TypeScript autocomplete for easy discovery.

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.


Built with ❀️ by VK

About

DecoProfile is a Component Library For Profile Decorations

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors