antd-elements
v1.0.1
Published
A React component library built with Ant Design and TypeScript.
Downloads
28
Maintainers
Readme
Here’s an updated and more engaging README.md
for antd-elements
:
antd-elements
antd-elements is a sleek and production-ready React component library built entirely on top of Ant Design. Designed to save you time, it offers customizable components that seamlessly integrate into your projects.
Features
✨ Powered by Ant Design: Combines the elegance of Ant Design with simplicity.
✨ Customizable Components: Reuse components without compromising on flexibility.
✨ TypeScript Support: Fully typed for a smooth developer experience.
Installation
Getting started is super simple! Install antd-elements in your project:
npm install antd-elements
Quick Start
Import and use any component in seconds. Here's an example:
EditableTextArea
import React from 'react';
import { EditableTextArea } from 'antd-elements';
const App = () => {
const handleUpdate = async (value: string) => {
console.log('Updated Value:', value);
};
return (
<div style={{ padding: '20px' }}>
<EditableTextArea initialValue="Hello, world!" onUpdate={handleUpdate} />
</div>
);
};
export default App;
Components
EditableTextArea
A handy text area with Save
and Cancel
buttons, perfect for inline editing scenarios.
Props
| Prop | Type | Description |
|----------------|-------------------------------------|-------------------------------------------------|
| initialValue
| string
| The starting text of the text area. |
| onUpdate
| (value: string) => Promise<void>
| Callback triggered on save with the new value. |
Why Use antd-elements?
💡 Efficiency: Prebuilt components save you coding time.
💡 Scalability: Designed to handle use cases big and small.
💡 Ant Design Inside: Uses the robust and visually consistent Ant Design library under the hood.
License
This project is licensed under the ISC License.
Made with ❤️ by Muhammad Wasil Islam
This version is compact, engaging, and focused on the core value of your library while simplifying the onboarding process. 🚀