This commit is contained in:
@@ -19,6 +19,13 @@ steps:
|
|||||||
- corepack prepare yarn@1.22.22 --activate
|
- corepack prepare yarn@1.22.22 --activate
|
||||||
- yarn install --frozen-lockfile
|
- yarn install --frozen-lockfile
|
||||||
|
|
||||||
|
- name: lint
|
||||||
|
image: node:22
|
||||||
|
commands:
|
||||||
|
- corepack enable
|
||||||
|
- corepack prepare yarn@1.22.22 --activate
|
||||||
|
- yarn lint
|
||||||
|
|
||||||
- name: build
|
- name: build
|
||||||
image: node:22
|
image: node:22
|
||||||
commands:
|
commands:
|
||||||
|
|||||||
5
.prettierignore
Normal file
5
.prettierignore
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
dist
|
||||||
|
coverage
|
||||||
|
storybook-static
|
||||||
|
node_modules
|
||||||
|
yarn.lock
|
||||||
7
.prettierrc
Normal file
7
.prettierrc
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json.schemastore.org/prettierrc",
|
||||||
|
"singleQuote": true,
|
||||||
|
"semi": true,
|
||||||
|
"printWidth": 100,
|
||||||
|
"tabWidth": 2
|
||||||
|
}
|
||||||
@@ -2,18 +2,14 @@ import type { StorybookConfig } from '@storybook/react-vite';
|
|||||||
|
|
||||||
const config: StorybookConfig = {
|
const config: StorybookConfig = {
|
||||||
stories: ['../src/**/*.stories.@(ts|tsx|mdx)'],
|
stories: ['../src/**/*.stories.@(ts|tsx|mdx)'],
|
||||||
addons: [
|
addons: ['@storybook/addon-docs', '@storybook/addon-a11y', '@storybook/addon-themes'],
|
||||||
'@storybook/addon-docs',
|
|
||||||
'@storybook/addon-a11y',
|
|
||||||
'@storybook/addon-themes'
|
|
||||||
],
|
|
||||||
framework: {
|
framework: {
|
||||||
name: '@storybook/react-vite',
|
name: '@storybook/react-vite',
|
||||||
options: {}
|
options: {},
|
||||||
},
|
},
|
||||||
docs: {
|
docs: {
|
||||||
autodocs: 'tag'
|
autodocs: 'tag',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export default config;
|
export default config;
|
||||||
|
|||||||
@@ -11,17 +11,17 @@ const preview: Preview = {
|
|||||||
<MemoryRouter>
|
<MemoryRouter>
|
||||||
<Story />
|
<Story />
|
||||||
</MemoryRouter>
|
</MemoryRouter>
|
||||||
)
|
),
|
||||||
],
|
],
|
||||||
parameters: {
|
parameters: {
|
||||||
controls: {
|
controls: {
|
||||||
matchers: {
|
matchers: {
|
||||||
color: /(background|color)$/i,
|
color: /(background|color)$/i,
|
||||||
date: /Date$/i
|
date: /Date$/i,
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
layout: 'centered'
|
layout: 'centered',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export default preview;
|
export default preview;
|
||||||
|
|||||||
48
eslint.config.mjs
Normal file
48
eslint.config.mjs
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
import js from '@eslint/js';
|
||||||
|
import reactHooks from 'eslint-plugin-react-hooks';
|
||||||
|
import reactRefresh from 'eslint-plugin-react-refresh';
|
||||||
|
import globals from 'globals';
|
||||||
|
import tseslint from 'typescript-eslint';
|
||||||
|
|
||||||
|
export default tseslint.config(
|
||||||
|
{
|
||||||
|
ignores: [
|
||||||
|
'dist',
|
||||||
|
'coverage',
|
||||||
|
'storybook-static',
|
||||||
|
'node_modules',
|
||||||
|
'*.config.cjs',
|
||||||
|
'vite.config.js',
|
||||||
|
'vite.config.d.ts',
|
||||||
|
'tailwind-preset.cjs',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
js.configs.recommended,
|
||||||
|
...tseslint.configs.recommended,
|
||||||
|
{
|
||||||
|
files: ['**/*.{ts,tsx}'],
|
||||||
|
languageOptions: {
|
||||||
|
ecmaVersion: 'latest',
|
||||||
|
sourceType: 'module',
|
||||||
|
globals: {
|
||||||
|
...globals.browser,
|
||||||
|
...globals.node,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
'no-empty': ['error', { allowEmptyCatch: true }],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
files: ['src/**/*.{ts,tsx}'],
|
||||||
|
ignores: ['src/**/*.stories.ts', 'src/**/*.stories.tsx'],
|
||||||
|
plugins: {
|
||||||
|
'react-hooks': reactHooks,
|
||||||
|
'react-refresh': reactRefresh,
|
||||||
|
},
|
||||||
|
rules: {
|
||||||
|
...reactHooks.configs.recommended.rules,
|
||||||
|
'react-refresh/only-export-components': ['warn', { allowConstantExport: true }],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
);
|
||||||
169
license.md
169
license.md
@@ -1,5 +1,4 @@
|
|||||||
GNU Affero General Public License
|
# GNU Affero General Public License
|
||||||
=================================
|
|
||||||
|
|
||||||
_Version 3, 19 November 2007_
|
_Version 3, 19 November 2007_
|
||||||
_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_
|
_Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>_
|
||||||
@@ -14,13 +13,13 @@ software and other kinds of works, specifically designed to ensure
|
|||||||
cooperation with the community in the case of network server software.
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
The licenses for most software and other practical works are designed
|
||||||
to take away your freedom to share and change the works. By contrast,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
share and change all versions of a program--to make sure it remains free
|
share and change all versions of a program--to make sure it remains free
|
||||||
software for all its users.
|
software for all its users.
|
||||||
|
|
||||||
When we speak of free software, we are referring to freedom, not
|
When we speak of free software, we are referring to freedom, not
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
have the freedom to distribute copies of free software (and charge for
|
have the freedom to distribute copies of free software (and charge for
|
||||||
them if you wish), that you receive source code or can get it if you
|
them if you wish), that you receive source code or can get it if you
|
||||||
want it, that you can change the software or use pieces of it in new
|
want it, that you can change the software or use pieces of it in new
|
||||||
@@ -34,8 +33,8 @@ and/or modify the software.
|
|||||||
A secondary benefit of defending all users' freedom is that
|
A secondary benefit of defending all users' freedom is that
|
||||||
improvements made in alternate versions of the program, if they
|
improvements made in alternate versions of the program, if they
|
||||||
receive widespread use, become available for other developers to
|
receive widespread use, become available for other developers to
|
||||||
incorporate. Many developers of free software are heartened and
|
incorporate. Many developers of free software are heartened and
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
software used on network servers, this result may fail to come about.
|
software used on network servers, this result may fail to come about.
|
||||||
The GNU General Public License permits making a modified version and
|
The GNU General Public License permits making a modified version and
|
||||||
letting the public access it on a server without ever releasing its
|
letting the public access it on a server without ever releasing its
|
||||||
@@ -43,14 +42,14 @@ source code to the public.
|
|||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
The GNU Affero General Public License is designed specifically to
|
||||||
ensure that, in such cases, the modified source code becomes available
|
ensure that, in such cases, the modified source code becomes available
|
||||||
to the community. It requires the operator of a network server to
|
to the community. It requires the operator of a network server to
|
||||||
provide the source code of the modified version running there to the
|
provide the source code of the modified version running there to the
|
||||||
users of that server. Therefore, public use of a modified version, on
|
users of that server. Therefore, public use of a modified version, on
|
||||||
a publicly accessible server, gives the public access to the source
|
a publicly accessible server, gives the public access to the source
|
||||||
code of the modified version.
|
code of the modified version.
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
An older license, called the Affero General Public License and
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
released a new version of the Affero GPL which permits relicensing under
|
released a new version of the Affero GPL which permits relicensing under
|
||||||
this license.
|
this license.
|
||||||
@@ -68,12 +67,12 @@ modification follow.
|
|||||||
works, such as semiconductor masks.
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
“The Program” refers to any copyrightable work licensed under this
|
“The Program” refers to any copyrightable work licensed under this
|
||||||
License. Each licensee is addressed as “you”. “Licensees” and
|
License. Each licensee is addressed as “you”. “Licensees” and
|
||||||
“recipients” may be individuals or organizations.
|
“recipients” may be individuals or organizations.
|
||||||
|
|
||||||
To “modify” a work means to copy from or adapt all or part of the work
|
To “modify” a work means to copy from or adapt all or part of the work
|
||||||
in a fashion requiring copyright permission, other than the making of an
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
exact copy. The resulting work is called a “modified version” of the
|
exact copy. The resulting work is called a “modified version” of the
|
||||||
earlier work or a work “based on” the earlier work.
|
earlier work or a work “based on” the earlier work.
|
||||||
|
|
||||||
A “covered work” means either the unmodified Program or a work based
|
A “covered work” means either the unmodified Program or a work based
|
||||||
@@ -82,12 +81,12 @@ on the Program.
|
|||||||
To “propagate” a work means to do anything with it that, without
|
To “propagate” a work means to do anything with it that, without
|
||||||
permission, would make you directly or secondarily liable for
|
permission, would make you directly or secondarily liable for
|
||||||
infringement under applicable copyright law, except executing it on a
|
infringement under applicable copyright law, except executing it on a
|
||||||
computer or modifying a private copy. Propagation includes copying,
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
distribution (with or without modification), making available to the
|
distribution (with or without modification), making available to the
|
||||||
public, and in some countries other activities as well.
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
To “convey” a work means any kind of propagation that enables other
|
To “convey” a work means any kind of propagation that enables other
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
An interactive user interface displays “Appropriate Legal Notices”
|
An interactive user interface displays “Appropriate Legal Notices”
|
||||||
@@ -95,14 +94,14 @@ to the extent that it includes a convenient and prominently visible
|
|||||||
feature that **(1)** displays an appropriate copyright notice, and **(2)**
|
feature that **(1)** displays an appropriate copyright notice, and **(2)**
|
||||||
tells the user that there is no warranty for the work (except to the
|
tells the user that there is no warranty for the work (except to the
|
||||||
extent that warranties are provided), that licensees may convey the
|
extent that warranties are provided), that licensees may convey the
|
||||||
work under this License, and how to view a copy of this License. If
|
work under this License, and how to view a copy of this License. If
|
||||||
the interface presents a list of user commands or options, such as a
|
the interface presents a list of user commands or options, such as a
|
||||||
menu, a prominent item in the list meets this criterion.
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
### 1. Source Code
|
### 1. Source Code
|
||||||
|
|
||||||
The “source code” for a work means the preferred form of the work
|
The “source code” for a work means the preferred form of the work
|
||||||
for making modifications to it. “Object code” means any non-source
|
for making modifications to it. “Object code” means any non-source
|
||||||
form of a work.
|
form of a work.
|
||||||
|
|
||||||
A “Standard Interface” means an interface that either is an official
|
A “Standard Interface” means an interface that either is an official
|
||||||
@@ -115,7 +114,7 @@ than the work as a whole, that **(a)** is included in the normal form of
|
|||||||
packaging a Major Component, but which is not part of that Major
|
packaging a Major Component, but which is not part of that Major
|
||||||
Component, and **(b)** serves only to enable use of the work with that
|
Component, and **(b)** serves only to enable use of the work with that
|
||||||
Major Component, or to implement a Standard Interface for which an
|
Major Component, or to implement a Standard Interface for which an
|
||||||
implementation is available to the public in source code form. A
|
implementation is available to the public in source code form. A
|
||||||
“Major Component”, in this context, means a major essential component
|
“Major Component”, in this context, means a major essential component
|
||||||
(kernel, window system, and so on) of the specific operating system
|
(kernel, window system, and so on) of the specific operating system
|
||||||
(if any) on which the executable work runs, or a compiler used to
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
@@ -124,10 +123,10 @@ produce the work, or an object code interpreter used to run it.
|
|||||||
The “Corresponding Source” for a work in object code form means all
|
The “Corresponding Source” for a work in object code form means all
|
||||||
the source code needed to generate, install, and (for an executable
|
the source code needed to generate, install, and (for an executable
|
||||||
work) run the object code and to modify the work, including scripts to
|
work) run the object code and to modify the work, including scripts to
|
||||||
control those activities. However, it does not include the work's
|
control those activities. However, it does not include the work's
|
||||||
System Libraries, or general-purpose tools or generally available free
|
System Libraries, or general-purpose tools or generally available free
|
||||||
programs which are used unmodified in performing those activities but
|
programs which are used unmodified in performing those activities but
|
||||||
which are not part of the work. For example, Corresponding Source
|
which are not part of the work. For example, Corresponding Source
|
||||||
includes interface definition files associated with source files for
|
includes interface definition files associated with source files for
|
||||||
the work, and the source code for shared libraries and dynamically
|
the work, and the source code for shared libraries and dynamically
|
||||||
linked subprograms that the work is specifically designed to require,
|
linked subprograms that the work is specifically designed to require,
|
||||||
@@ -145,25 +144,25 @@ same work.
|
|||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
All rights granted under this License are granted for the term of
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
conditions are met. This License explicitly affirms your unlimited
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
permission to run the unmodified Program. The output from running a
|
permission to run the unmodified Program. The output from running a
|
||||||
covered work is covered by this License only if the output, given its
|
covered work is covered by this License only if the output, given its
|
||||||
content, constitutes a covered work. This License acknowledges your
|
content, constitutes a covered work. This License acknowledges your
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
You may make, run and propagate covered works that you do not
|
||||||
convey, without conditions so long as your license otherwise remains
|
convey, without conditions so long as your license otherwise remains
|
||||||
in force. You may convey covered works to others for the sole purpose
|
in force. You may convey covered works to others for the sole purpose
|
||||||
of having them make modifications exclusively for you, or provide you
|
of having them make modifications exclusively for you, or provide you
|
||||||
with facilities for running those works, provided that you comply with
|
with facilities for running those works, provided that you comply with
|
||||||
the terms of this License in conveying all material for which you do
|
the terms of this License in conveying all material for which you do
|
||||||
not control copyright. Those thus making or running the covered works
|
not control copyright. Those thus making or running the covered works
|
||||||
for you must do so exclusively on your behalf, under your direction
|
for you must do so exclusively on your behalf, under your direction
|
||||||
and control, on terms that prohibit them from making any copies of
|
and control, on terms that prohibit them from making any copies of
|
||||||
your copyrighted material outside their relationship with you.
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
Conveying under any other circumstances is permitted solely under
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
makes it unnecessary.
|
makes it unnecessary.
|
||||||
|
|
||||||
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law
|
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law
|
||||||
@@ -201,20 +200,20 @@ You may convey a work based on the Program, or the modifications to
|
|||||||
produce it from the Program, in the form of source code under the
|
produce it from the Program, in the form of source code under the
|
||||||
terms of section 4, provided that you also meet all of these conditions:
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
* **a)** The work must carry prominent notices stating that you modified
|
- **a)** The work must carry prominent notices stating that you modified
|
||||||
it, and giving a relevant date.
|
it, and giving a relevant date.
|
||||||
* **b)** The work must carry prominent notices stating that it is
|
- **b)** The work must carry prominent notices stating that it is
|
||||||
released under this License and any conditions added under section 7.
|
released under this License and any conditions added under section 7.
|
||||||
This requirement modifies the requirement in section 4 to
|
This requirement modifies the requirement in section 4 to
|
||||||
“keep intact all notices”.
|
“keep intact all notices”.
|
||||||
* **c)** You must license the entire work, as a whole, under this
|
- **c)** You must license the entire work, as a whole, under this
|
||||||
License to anyone who comes into possession of a copy. This
|
License to anyone who comes into possession of a copy. This
|
||||||
License will therefore apply, along with any applicable section 7
|
License will therefore apply, along with any applicable section 7
|
||||||
additional terms, to the whole of the work, and all its parts,
|
additional terms, to the whole of the work, and all its parts,
|
||||||
regardless of how they are packaged. This License gives no
|
regardless of how they are packaged. This License gives no
|
||||||
permission to license the work in any other way, but it does not
|
permission to license the work in any other way, but it does not
|
||||||
invalidate such permission if you have separately received it.
|
invalidate such permission if you have separately received it.
|
||||||
* **d)** If the work has interactive user interfaces, each must display
|
- **d)** If the work has interactive user interfaces, each must display
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
work need not make them do so.
|
work need not make them do so.
|
||||||
@@ -225,7 +224,7 @@ and which are not combined with it such as to form a larger program,
|
|||||||
in or on a volume of a storage or distribution medium, is called an
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
“aggregate” if the compilation and its resulting copyright are not
|
“aggregate” if the compilation and its resulting copyright are not
|
||||||
used to limit the access or legal rights of the compilation's users
|
used to limit the access or legal rights of the compilation's users
|
||||||
beyond what the individual works permit. Inclusion of a covered work
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
in an aggregate does not cause this License to apply to the other
|
in an aggregate does not cause this License to apply to the other
|
||||||
parts of the aggregate.
|
parts of the aggregate.
|
||||||
|
|
||||||
@@ -236,11 +235,11 @@ of sections 4 and 5, provided that you also convey the
|
|||||||
machine-readable Corresponding Source under the terms of this License,
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
in one of these ways:
|
in one of these ways:
|
||||||
|
|
||||||
* **a)** Convey the object code in, or embodied in, a physical product
|
- **a)** Convey the object code in, or embodied in, a physical product
|
||||||
(including a physical distribution medium), accompanied by the
|
(including a physical distribution medium), accompanied by the
|
||||||
Corresponding Source fixed on a durable physical medium
|
Corresponding Source fixed on a durable physical medium
|
||||||
customarily used for software interchange.
|
customarily used for software interchange.
|
||||||
* **b)** Convey the object code in, or embodied in, a physical product
|
- **b)** Convey the object code in, or embodied in, a physical product
|
||||||
(including a physical distribution medium), accompanied by a
|
(including a physical distribution medium), accompanied by a
|
||||||
written offer, valid for at least three years and valid for as
|
written offer, valid for at least three years and valid for as
|
||||||
long as you offer spare parts or customer support for that product
|
long as you offer spare parts or customer support for that product
|
||||||
@@ -251,24 +250,24 @@ in one of these ways:
|
|||||||
more than your reasonable cost of physically performing this
|
more than your reasonable cost of physically performing this
|
||||||
conveying of source, or **(2)** access to copy the
|
conveying of source, or **(2)** access to copy the
|
||||||
Corresponding Source from a network server at no charge.
|
Corresponding Source from a network server at no charge.
|
||||||
* **c)** Convey individual copies of the object code with a copy of the
|
- **c)** Convey individual copies of the object code with a copy of the
|
||||||
written offer to provide the Corresponding Source. This
|
written offer to provide the Corresponding Source. This
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
only if you received the object code with such an offer, in accord
|
only if you received the object code with such an offer, in accord
|
||||||
with subsection 6b.
|
with subsection 6b.
|
||||||
* **d)** Convey the object code by offering access from a designated
|
- **d)** Convey the object code by offering access from a designated
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
Corresponding Source in the same way through the same place at no
|
Corresponding Source in the same way through the same place at no
|
||||||
further charge. You need not require recipients to copy the
|
further charge. You need not require recipients to copy the
|
||||||
Corresponding Source along with the object code. If the place to
|
Corresponding Source along with the object code. If the place to
|
||||||
copy the object code is a network server, the Corresponding Source
|
copy the object code is a network server, the Corresponding Source
|
||||||
may be on a different server (operated by you or a third party)
|
may be on a different server (operated by you or a third party)
|
||||||
that supports equivalent copying facilities, provided you maintain
|
that supports equivalent copying facilities, provided you maintain
|
||||||
clear directions next to the object code saying where to find the
|
clear directions next to the object code saying where to find the
|
||||||
Corresponding Source. Regardless of what server hosts the
|
Corresponding Source. Regardless of what server hosts the
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
available for as long as needed to satisfy these requirements.
|
available for as long as needed to satisfy these requirements.
|
||||||
* **e)** Convey the object code using peer-to-peer transmission, provided
|
- **e)** Convey the object code using peer-to-peer transmission, provided
|
||||||
you inform other peers where the object code and Corresponding
|
you inform other peers where the object code and Corresponding
|
||||||
Source of the work are being offered to the general public at no
|
Source of the work are being offered to the general public at no
|
||||||
charge under subsection 6d.
|
charge under subsection 6d.
|
||||||
@@ -280,12 +279,12 @@ included in conveying the object code work.
|
|||||||
A “User Product” is either **(1)** a “consumer product”, which means any
|
A “User Product” is either **(1)** a “consumer product”, which means any
|
||||||
tangible personal property which is normally used for personal, family,
|
tangible personal property which is normally used for personal, family,
|
||||||
or household purposes, or **(2)** anything designed or sold for incorporation
|
or household purposes, or **(2)** anything designed or sold for incorporation
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
product received by a particular user, “normally used” refers to a
|
product received by a particular user, “normally used” refers to a
|
||||||
typical or common use of that class of product, regardless of the status
|
typical or common use of that class of product, regardless of the status
|
||||||
of the particular user or of the way in which the particular user
|
of the particular user or of the way in which the particular user
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
is a consumer product regardless of whether the product has substantial
|
is a consumer product regardless of whether the product has substantial
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
the only significant mode of use of the product.
|
the only significant mode of use of the product.
|
||||||
@@ -293,7 +292,7 @@ the only significant mode of use of the product.
|
|||||||
“Installation Information” for a User Product means any methods,
|
“Installation Information” for a User Product means any methods,
|
||||||
procedures, authorization keys, or other information required to install
|
procedures, authorization keys, or other information required to install
|
||||||
and execute modified versions of a covered work in that User Product from
|
and execute modified versions of a covered work in that User Product from
|
||||||
a modified version of its Corresponding Source. The information must
|
a modified version of its Corresponding Source. The information must
|
||||||
suffice to ensure that the continued functioning of the modified object
|
suffice to ensure that the continued functioning of the modified object
|
||||||
code is in no case prevented or interfered with solely because
|
code is in no case prevented or interfered with solely because
|
||||||
modification has been made.
|
modification has been made.
|
||||||
@@ -304,7 +303,7 @@ part of a transaction in which the right of possession and use of the
|
|||||||
User Product is transferred to the recipient in perpetuity or for a
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
fixed term (regardless of how the transaction is characterized), the
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
Corresponding Source conveyed under this section must be accompanied
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
by the Installation Information. But this requirement does not apply
|
by the Installation Information. But this requirement does not apply
|
||||||
if neither you nor any third party retains the ability to install
|
if neither you nor any third party retains the ability to install
|
||||||
modified object code on the User Product (for example, the work has
|
modified object code on the User Product (for example, the work has
|
||||||
been installed in ROM).
|
been installed in ROM).
|
||||||
@@ -312,7 +311,7 @@ been installed in ROM).
|
|||||||
The requirement to provide Installation Information does not include a
|
The requirement to provide Installation Information does not include a
|
||||||
requirement to continue to provide support service, warranty, or updates
|
requirement to continue to provide support service, warranty, or updates
|
||||||
for a work that has been modified or installed by the recipient, or for
|
for a work that has been modified or installed by the recipient, or for
|
||||||
the User Product in which it has been modified or installed. Access to a
|
the User Product in which it has been modified or installed. Access to a
|
||||||
network may be denied when the modification itself materially and
|
network may be denied when the modification itself materially and
|
||||||
adversely affects the operation of the network or violates the rules and
|
adversely affects the operation of the network or violates the rules and
|
||||||
protocols for communication across the network.
|
protocols for communication across the network.
|
||||||
@@ -329,15 +328,15 @@ unpacking, reading or copying.
|
|||||||
License by making exceptions from one or more of its conditions.
|
License by making exceptions from one or more of its conditions.
|
||||||
Additional permissions that are applicable to the entire Program shall
|
Additional permissions that are applicable to the entire Program shall
|
||||||
be treated as though they were included in this License, to the extent
|
be treated as though they were included in this License, to the extent
|
||||||
that they are valid under applicable law. If additional permissions
|
that they are valid under applicable law. If additional permissions
|
||||||
apply only to part of the Program, that part may be used separately
|
apply only to part of the Program, that part may be used separately
|
||||||
under those permissions, but the entire Program remains governed by
|
under those permissions, but the entire Program remains governed by
|
||||||
this License without regard to the additional permissions.
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
When you convey a copy of a covered work, you may at your option
|
When you convey a copy of a covered work, you may at your option
|
||||||
remove any additional permissions from that copy, or from any part of
|
remove any additional permissions from that copy, or from any part of
|
||||||
it. (Additional permissions may be written to require their own
|
it. (Additional permissions may be written to require their own
|
||||||
removal in certain cases when you modify the work.) You may place
|
removal in certain cases when you modify the work.) You may place
|
||||||
additional permissions on material, added by you to a covered work,
|
additional permissions on material, added by you to a covered work,
|
||||||
for which you have or can give appropriate copyright permission.
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
@@ -345,29 +344,29 @@ Notwithstanding any other provision of this License, for material you
|
|||||||
add to a covered work, you may (if authorized by the copyright holders of
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
that material) supplement the terms of this License with terms:
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
* **a)** Disclaiming warranty or limiting liability differently from the
|
- **a)** Disclaiming warranty or limiting liability differently from the
|
||||||
terms of sections 15 and 16 of this License; or
|
terms of sections 15 and 16 of this License; or
|
||||||
* **b)** Requiring preservation of specified reasonable legal notices or
|
- **b)** Requiring preservation of specified reasonable legal notices or
|
||||||
author attributions in that material or in the Appropriate Legal
|
author attributions in that material or in the Appropriate Legal
|
||||||
Notices displayed by works containing it; or
|
Notices displayed by works containing it; or
|
||||||
* **c)** Prohibiting misrepresentation of the origin of that material, or
|
- **c)** Prohibiting misrepresentation of the origin of that material, or
|
||||||
requiring that modified versions of such material be marked in
|
requiring that modified versions of such material be marked in
|
||||||
reasonable ways as different from the original version; or
|
reasonable ways as different from the original version; or
|
||||||
* **d)** Limiting the use for publicity purposes of names of licensors or
|
- **d)** Limiting the use for publicity purposes of names of licensors or
|
||||||
authors of the material; or
|
authors of the material; or
|
||||||
* **e)** Declining to grant rights under trademark law for use of some
|
- **e)** Declining to grant rights under trademark law for use of some
|
||||||
trade names, trademarks, or service marks; or
|
trade names, trademarks, or service marks; or
|
||||||
* **f)** Requiring indemnification of licensors and authors of that
|
- **f)** Requiring indemnification of licensors and authors of that
|
||||||
material by anyone who conveys the material (or modified versions of
|
material by anyone who conveys the material (or modified versions of
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
any liability that these contractual assumptions directly impose on
|
any liability that these contractual assumptions directly impose on
|
||||||
those licensors and authors.
|
those licensors and authors.
|
||||||
|
|
||||||
All other non-permissive additional terms are considered “further
|
All other non-permissive additional terms are considered “further
|
||||||
restrictions” within the meaning of section 10. If the Program as you
|
restrictions” within the meaning of section 10. If the Program as you
|
||||||
received it, or any part of it, contains a notice stating that it is
|
received it, or any part of it, contains a notice stating that it is
|
||||||
governed by this License along with a term that is a further
|
governed by this License along with a term that is a further
|
||||||
restriction, you may remove that term. If a license document contains
|
restriction, you may remove that term. If a license document contains
|
||||||
a further restriction but permits relicensing or conveying under this
|
a further restriction but permits relicensing or conveying under this
|
||||||
License, you may add to a covered work material governed by the terms
|
License, you may add to a covered work material governed by the terms
|
||||||
of that license document, provided that the further restriction does
|
of that license document, provided that the further restriction does
|
||||||
@@ -385,7 +384,7 @@ the above requirements apply either way.
|
|||||||
### 8. Termination
|
### 8. Termination
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
You may not propagate or modify a covered work except as expressly
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
modify it is void, and will automatically terminate your rights under
|
modify it is void, and will automatically terminate your rights under
|
||||||
this License (including any patent licenses granted under the third
|
this License (including any patent licenses granted under the third
|
||||||
paragraph of section 11).
|
paragraph of section 11).
|
||||||
@@ -406,31 +405,31 @@ your receipt of the notice.
|
|||||||
|
|
||||||
Termination of your rights under this section does not terminate the
|
Termination of your rights under this section does not terminate the
|
||||||
licenses of parties who have received copies or rights from you under
|
licenses of parties who have received copies or rights from you under
|
||||||
this License. If your rights have been terminated and not permanently
|
this License. If your rights have been terminated and not permanently
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
material under section 10.
|
material under section 10.
|
||||||
|
|
||||||
### 9. Acceptance Not Required for Having Copies
|
### 9. Acceptance Not Required for Having Copies
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
You are not required to accept this License in order to receive or
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
to receive a copy likewise does not require acceptance. However,
|
to receive a copy likewise does not require acceptance. However,
|
||||||
nothing other than this License grants you permission to propagate or
|
nothing other than this License grants you permission to propagate or
|
||||||
modify any covered work. These actions infringe copyright if you do
|
modify any covered work. These actions infringe copyright if you do
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
### 10. Automatic Licensing of Downstream Recipients
|
### 10. Automatic Licensing of Downstream Recipients
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
Each time you convey a covered work, the recipient automatically
|
||||||
receives a license from the original licensors, to run, modify and
|
receives a license from the original licensors, to run, modify and
|
||||||
propagate that work, subject to this License. You are not responsible
|
propagate that work, subject to this License. You are not responsible
|
||||||
for enforcing compliance by third parties with this License.
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
An “entity transaction” is a transaction transferring control of an
|
An “entity transaction” is a transaction transferring control of an
|
||||||
organization, or substantially all assets of one, or subdividing an
|
organization, or substantially all assets of one, or subdividing an
|
||||||
organization, or merging organizations. If propagation of a covered
|
organization, or merging organizations. If propagation of a covered
|
||||||
work results from an entity transaction, each party to that
|
work results from an entity transaction, each party to that
|
||||||
transaction who receives a copy of the work also receives whatever
|
transaction who receives a copy of the work also receives whatever
|
||||||
licenses to the work the party's predecessor in interest had or could
|
licenses to the work the party's predecessor in interest had or could
|
||||||
@@ -439,7 +438,7 @@ Corresponding Source of the work from the predecessor in interest, if
|
|||||||
the predecessor has it or can get it with reasonable efforts.
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
You may not impose any further restrictions on the exercise of the
|
You may not impose any further restrictions on the exercise of the
|
||||||
rights granted or affirmed under this License. For example, you may
|
rights granted or affirmed under this License. For example, you may
|
||||||
not impose a license fee, royalty, or other charge for exercise of
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
rights granted under this License, and you may not initiate litigation
|
rights granted under this License, and you may not initiate litigation
|
||||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
@@ -449,7 +448,7 @@ sale, or importing the Program or any portion of it.
|
|||||||
### 11. Patents
|
### 11. Patents
|
||||||
|
|
||||||
A “contributor” is a copyright holder who authorizes use under this
|
A “contributor” is a copyright holder who authorizes use under this
|
||||||
License of the Program or a work on which the Program is based. The
|
License of the Program or a work on which the Program is based. The
|
||||||
work thus licensed is called the contributor's “contributor version”.
|
work thus licensed is called the contributor's “contributor version”.
|
||||||
|
|
||||||
A contributor's “essential patent claims” are all patent claims
|
A contributor's “essential patent claims” are all patent claims
|
||||||
@@ -457,7 +456,7 @@ owned or controlled by the contributor, whether already acquired or
|
|||||||
hereafter acquired, that would be infringed by some manner, permitted
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
by this License, of making, using, or selling its contributor version,
|
by this License, of making, using, or selling its contributor version,
|
||||||
but do not include claims that would be infringed only as a
|
but do not include claims that would be infringed only as a
|
||||||
consequence of further modification of the contributor version. For
|
consequence of further modification of the contributor version. For
|
||||||
purposes of this definition, “control” includes the right to grant
|
purposes of this definition, “control” includes the right to grant
|
||||||
patent sublicenses in a manner consistent with the requirements of
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
this License.
|
this License.
|
||||||
@@ -470,7 +469,7 @@ propagate the contents of its contributor version.
|
|||||||
In the following three paragraphs, a “patent license” is any express
|
In the following three paragraphs, a “patent license” is any express
|
||||||
agreement or commitment, however denominated, not to enforce a patent
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
(such as an express permission to practice a patent or covenant not to
|
(such as an express permission to practice a patent or covenant not to
|
||||||
sue for patent infringement). To “grant” such a patent license to a
|
sue for patent infringement). To “grant” such a patent license to a
|
||||||
party means to make such an agreement or commitment not to enforce a
|
party means to make such an agreement or commitment not to enforce a
|
||||||
patent against the party.
|
patent against the party.
|
||||||
|
|
||||||
@@ -482,7 +481,7 @@ then you must either **(1)** cause the Corresponding Source to be so
|
|||||||
available, or **(2)** arrange to deprive yourself of the benefit of the
|
available, or **(2)** arrange to deprive yourself of the benefit of the
|
||||||
patent license for this particular work, or **(3)** arrange, in a manner
|
patent license for this particular work, or **(3)** arrange, in a manner
|
||||||
consistent with the requirements of this License, to extend the patent
|
consistent with the requirements of this License, to extend the patent
|
||||||
license to downstream recipients. “Knowingly relying” means you have
|
license to downstream recipients. “Knowingly relying” means you have
|
||||||
actual knowledge that, but for the patent license, your conveying the
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
covered work in a country, or your recipient's use of the covered work
|
covered work in a country, or your recipient's use of the covered work
|
||||||
in a country, would infringe one or more identifiable patents in that
|
in a country, would infringe one or more identifiable patents in that
|
||||||
@@ -499,7 +498,7 @@ work and works based on it.
|
|||||||
A patent license is “discriminatory” if it does not include within
|
A patent license is “discriminatory” if it does not include within
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
specifically granted under this License. You may not convey a covered
|
specifically granted under this License. You may not convey a covered
|
||||||
work if you are a party to an arrangement with a third party that is
|
work if you are a party to an arrangement with a third party that is
|
||||||
in the business of distributing software, under which you make payment
|
in the business of distributing software, under which you make payment
|
||||||
to the third party based on the extent of your activity of conveying
|
to the third party based on the extent of your activity of conveying
|
||||||
@@ -519,10 +518,10 @@ otherwise be available to you under applicable patent law.
|
|||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
the Program, the only way you could satisfy both those terms and this
|
the Program, the only way you could satisfy both those terms and this
|
||||||
License would be to refrain entirely from conveying the Program.
|
License would be to refrain entirely from conveying the Program.
|
||||||
@@ -535,7 +534,7 @@ interacting with it remotely through a computer network (if your version
|
|||||||
supports such interaction) an opportunity to receive the Corresponding
|
supports such interaction) an opportunity to receive the Corresponding
|
||||||
Source of your version by providing access to the Corresponding Source
|
Source of your version by providing access to the Corresponding Source
|
||||||
from a network server at no charge, through some standard or customary
|
from a network server at no charge, through some standard or customary
|
||||||
means of facilitating copying of software. This Corresponding Source
|
means of facilitating copying of software. This Corresponding Source
|
||||||
shall include the Corresponding Source for any work covered by version 3
|
shall include the Corresponding Source for any work covered by version 3
|
||||||
of the GNU General Public License that is incorporated pursuant to the
|
of the GNU General Public License that is incorporated pursuant to the
|
||||||
following paragraph.
|
following paragraph.
|
||||||
@@ -543,7 +542,7 @@ following paragraph.
|
|||||||
Notwithstanding any other provision of this License, you have
|
Notwithstanding any other provision of this License, you have
|
||||||
permission to link or combine any covered work with a work licensed
|
permission to link or combine any covered work with a work licensed
|
||||||
under version 3 of the GNU General Public License into a single
|
under version 3 of the GNU General Public License into a single
|
||||||
combined work, and to convey the resulting work. The terms of this
|
combined work, and to convey the resulting work. The terms of this
|
||||||
License will continue to apply to the part which is the covered work,
|
License will continue to apply to the part which is the covered work,
|
||||||
but the work with which it is combined will remain governed by version
|
but the work with which it is combined will remain governed by version
|
||||||
3 of the GNU General Public License.
|
3 of the GNU General Public License.
|
||||||
@@ -551,16 +550,16 @@ but the work with which it is combined will remain governed by version
|
|||||||
### 14. Revised Versions of this License
|
### 14. Revised Versions of this License
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
the GNU Affero General Public License from time to time. Such new versions
|
the GNU Affero General Public License from time to time. Such new versions
|
||||||
will be similar in spirit to the present version, but may differ in detail to
|
will be similar in spirit to the present version, but may differ in detail to
|
||||||
address new problems or concerns.
|
address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the
|
||||||
Program specifies that a certain numbered version of the GNU Affero General
|
Program specifies that a certain numbered version of the GNU Affero General
|
||||||
Public License “or any later version” applies to it, you have the
|
Public License “or any later version” applies to it, you have the
|
||||||
option of following the terms and conditions either of that numbered
|
option of following the terms and conditions either of that numbered
|
||||||
version or of any later version published by the Free Software
|
version or of any later version published by the Free Software
|
||||||
Foundation. If the Program does not specify a version number of the
|
Foundation. If the Program does not specify a version number of the
|
||||||
GNU Affero General Public License, you may choose any version ever published
|
GNU Affero General Public License, you may choose any version ever published
|
||||||
by the Free Software Foundation.
|
by the Free Software Foundation.
|
||||||
|
|
||||||
@@ -570,19 +569,19 @@ public statement of acceptance of a version permanently authorizes you
|
|||||||
to choose that version for the Program.
|
to choose that version for the Program.
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
Later license versions may give you additional or different
|
||||||
permissions. However, no additional obligations are imposed on any
|
permissions. However, no additional obligations are imposed on any
|
||||||
author or copyright holder as a result of your choosing to follow a
|
author or copyright holder as a result of your choosing to follow a
|
||||||
later version.
|
later version.
|
||||||
|
|
||||||
### 15. Disclaimer of Warranty
|
### 15. Disclaimer of Warranty
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
### 16. Limitation of Liability
|
### 16. Limitation of Liability
|
||||||
@@ -614,7 +613,7 @@ If you develop a new program, and you want it to be of the greatest
|
|||||||
possible use to the public, the best way to achieve this is to make it
|
possible use to the public, the best way to achieve this is to make it
|
||||||
free software which everyone can redistribute and change under these terms.
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
To do so, attach the following notices to the program. It is safest
|
||||||
to attach them to the start of each source file to most effectively
|
to attach them to the start of each source file to most effectively
|
||||||
state the exclusion of warranty; and each file should have at least
|
state the exclusion of warranty; and each file should have at least
|
||||||
the “copyright” line and a pointer to where the full notice is found.
|
the “copyright” line and a pointer to where the full notice is found.
|
||||||
@@ -639,9 +638,9 @@ Also add information on how to contact you by electronic and paper mail.
|
|||||||
|
|
||||||
If your software can interact with users remotely through a computer
|
If your software can interact with users remotely through a computer
|
||||||
network, you should also make sure that it provides a way for users to
|
network, you should also make sure that it provides a way for users to
|
||||||
get its source. For example, if your program is a web application, its
|
get its source. For example, if your program is a web application, its
|
||||||
interface could display a “Source” link that leads users to an archive
|
interface could display a “Source” link that leads users to an archive
|
||||||
of the code. There are many ways you could offer source, and different
|
of the code. There are many ways you could offer source, and different
|
||||||
solutions will be better for different programs; see section 13 for the
|
solutions will be better for different programs; see section 13 for the
|
||||||
specific requirements.
|
specific requirements.
|
||||||
|
|
||||||
|
|||||||
11
package.json
11
package.json
@@ -27,6 +27,10 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"clean": "rm -rf dist",
|
"clean": "rm -rf dist",
|
||||||
"build": "yarn clean && vite build && tsc -p tsconfig.build.json && mkdir -p dist/styles && cp src/styles/base.css dist/styles/base.css && tailwindcss -c tailwind.build.config.cjs -i src/styles/components.css -o dist/styles/components.css --minify && tailwindcss -c tailwind.build.config.cjs -i src/styles/utilities.css -o dist/styles/utilities.css --minify && cp tailwind-preset.cjs dist/tailwind-preset.cjs",
|
"build": "yarn clean && vite build && tsc -p tsconfig.build.json && mkdir -p dist/styles && cp src/styles/base.css dist/styles/base.css && tailwindcss -c tailwind.build.config.cjs -i src/styles/components.css -o dist/styles/components.css --minify && tailwindcss -c tailwind.build.config.cjs -i src/styles/utilities.css -o dist/styles/utilities.css --minify && cp tailwind-preset.cjs dist/tailwind-preset.cjs",
|
||||||
|
"lint": "eslint .",
|
||||||
|
"lint:fix": "eslint . --fix",
|
||||||
|
"format": "prettier . --write",
|
||||||
|
"format:check": "prettier . --check",
|
||||||
"storybook": "storybook dev -p 6006",
|
"storybook": "storybook dev -p 6006",
|
||||||
"build-storybook": "storybook build",
|
"build-storybook": "storybook build",
|
||||||
"prepublishOnly": "yarn build",
|
"prepublishOnly": "yarn build",
|
||||||
@@ -50,6 +54,7 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@codemirror/language": "^6.11.3",
|
"@codemirror/language": "^6.11.3",
|
||||||
|
"@eslint/js": "^9",
|
||||||
"@heroicons/react": "^2.2.0",
|
"@heroicons/react": "^2.2.0",
|
||||||
"@lezer/highlight": "^1.2.1",
|
"@lezer/highlight": "^1.2.1",
|
||||||
"@mdxeditor/editor": "^3.52.4",
|
"@mdxeditor/editor": "^3.52.4",
|
||||||
@@ -62,13 +67,19 @@
|
|||||||
"@types/react": "^19.0.0",
|
"@types/react": "^19.0.0",
|
||||||
"@types/react-dom": "^19.0.0",
|
"@types/react-dom": "^19.0.0",
|
||||||
"@vitejs/plugin-react": "^5.0.0",
|
"@vitejs/plugin-react": "^5.0.0",
|
||||||
|
"eslint": "^9",
|
||||||
|
"eslint-plugin-react-hooks": "^7.0.1",
|
||||||
|
"eslint-plugin-react-refresh": "^0.5.1",
|
||||||
|
"globals": "^17.3.0",
|
||||||
"postcss": "^8.4.49",
|
"postcss": "^8.4.49",
|
||||||
|
"prettier": "^3.8.1",
|
||||||
"react": "^19.0.0",
|
"react": "^19.0.0",
|
||||||
"react-dom": "^19.0.0",
|
"react-dom": "^19.0.0",
|
||||||
"react-router-dom": "^7.0.0",
|
"react-router-dom": "^7.0.0",
|
||||||
"storybook": "^10.2.10",
|
"storybook": "^10.2.10",
|
||||||
"tailwindcss": "^3.4.16",
|
"tailwindcss": "^3.4.16",
|
||||||
"typescript": "^5.6.2",
|
"typescript": "^5.6.2",
|
||||||
|
"typescript-eslint": "^8.56.0",
|
||||||
"vite": "^7.0.0",
|
"vite": "^7.0.0",
|
||||||
"yjs": "^13.6.24"
|
"yjs": "^13.6.24"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
module.exports = {
|
module.exports = {
|
||||||
plugins: {
|
plugins: {
|
||||||
tailwindcss: {
|
tailwindcss: {
|
||||||
config: './tailwind.storybook.config.cjs'
|
config: './tailwind.storybook.config.cjs',
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -9,77 +9,79 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Polymorphic button component: renders a native `<button>` or a React Router `<Link>` when `to` is provided.'
|
component:
|
||||||
}
|
'Polymorphic button component: renders a native `<button>` or a React Router `<Link>` when `to` is provided.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
label: {
|
label: {
|
||||||
description: 'Visible button label text.',
|
description: 'Visible button label text.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
type: {
|
type: {
|
||||||
description: 'Base visual style.',
|
description: 'Base visual style.',
|
||||||
options: ['solid', 'outlined', 'noborder'],
|
options: ['solid', 'outlined', 'noborder'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'solid' | 'outlined' | 'noborder'" } }
|
table: { type: { summary: "'solid' | 'outlined' | 'noborder'" } },
|
||||||
},
|
},
|
||||||
variant: {
|
variant: {
|
||||||
description: 'Color variant. If omitted: `primary` for `solid`, `secondary` for the other types.',
|
description:
|
||||||
|
'Color variant. If omitted: `primary` for `solid`, `secondary` for the other types.',
|
||||||
options: ['primary', 'secondary', 'important'],
|
options: ['primary', 'secondary', 'important'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'primary' | 'secondary' | 'important'" } }
|
table: { type: { summary: "'primary' | 'secondary' | 'important'" } },
|
||||||
},
|
},
|
||||||
size: {
|
size: {
|
||||||
description: 'Button size.',
|
description: 'Button size.',
|
||||||
options: ['sm', 'md', 'lg', 'full'],
|
options: ['sm', 'md', 'lg', 'full'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } }
|
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } },
|
||||||
},
|
},
|
||||||
to: {
|
to: {
|
||||||
description: 'Navigation path. When set, the component renders a `<Link>`.',
|
description: 'Navigation path. When set, the component renders a `<Link>`.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
htmlType: {
|
htmlType: {
|
||||||
description: 'HTML button type used when rendering a native `<button>`.',
|
description: 'HTML button type used when rendering a native `<button>`.',
|
||||||
options: ['button', 'submit', 'reset'],
|
options: ['button', 'submit', 'reset'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'button' | 'submit' | 'reset'" } }
|
table: { type: { summary: "'button' | 'submit' | 'reset'" } },
|
||||||
},
|
},
|
||||||
disabled: {
|
disabled: {
|
||||||
description: 'Disables interaction and hover/click states.',
|
description: 'Disables interaction and hover/click states.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
icon: {
|
icon: {
|
||||||
description: 'Optional icon component (for example Heroicons).',
|
description: 'Optional icon component (for example Heroicons).',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ElementType' } }
|
table: { type: { summary: 'ElementType' } },
|
||||||
},
|
},
|
||||||
ariaLabel: {
|
ariaLabel: {
|
||||||
description: 'Accessible label. Falls back to `label` when not provided.',
|
description: 'Accessible label. Falls back to `label` when not provided.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the root element.',
|
description: 'Extra CSS classes for the root element.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
onClick: {
|
onClick: {
|
||||||
description: 'Click handler callback.',
|
description: 'Click handler callback.',
|
||||||
action: 'clicked',
|
action: 'clicked',
|
||||||
table: { type: { summary: 'MouseEventHandler<HTMLElement>' } }
|
table: { type: { summary: 'MouseEventHandler<HTMLElement>' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
type: 'solid',
|
type: 'solid',
|
||||||
variant: 'primary',
|
variant: 'primary',
|
||||||
size: 'md',
|
size: 'md',
|
||||||
label: 'Save'
|
label: 'Save',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof Button>;
|
} satisfies Meta<typeof Button>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -91,37 +93,37 @@ export const SolidImportant: Story = {
|
|||||||
args: {
|
args: {
|
||||||
type: 'solid',
|
type: 'solid',
|
||||||
variant: 'important',
|
variant: 'important',
|
||||||
label: 'Delete'
|
label: 'Delete',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const OutlinedSecondary: Story = {
|
export const OutlinedSecondary: Story = {
|
||||||
args: {
|
args: {
|
||||||
type: 'outlined',
|
type: 'outlined',
|
||||||
variant: 'secondary',
|
variant: 'secondary',
|
||||||
label: 'Cancel'
|
label: 'Cancel',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const IconOnly: Story = {
|
export const IconOnly: Story = {
|
||||||
args: {
|
args: {
|
||||||
icon: PlusIcon,
|
icon: PlusIcon,
|
||||||
label: undefined,
|
label: undefined,
|
||||||
ariaLabel: 'Add item'
|
ariaLabel: 'Add item',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const LinkButton: Story = {
|
export const LinkButton: Story = {
|
||||||
args: {
|
args: {
|
||||||
to: '/demo',
|
to: '/demo',
|
||||||
label: 'Go to demo'
|
label: 'Go to demo',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Disabled: Story = {
|
export const Disabled: Story = {
|
||||||
args: {
|
args: {
|
||||||
disabled: true
|
disabled: true,
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const SizeMatrix: Story = {
|
export const SizeMatrix: Story = {
|
||||||
@@ -132,5 +134,5 @@ export const SizeMatrix: Story = {
|
|||||||
<Button {...args} size="lg" label="Large" />
|
<Button {...args} size="lg" label="Large" />
|
||||||
<Button {...args} size="full" label="Full width" />
|
<Button {...args} size="full" label="Full width" />
|
||||||
</div>
|
</div>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -24,40 +24,40 @@ const SIZE_CLASS: Record<ComponentSize, string> = {
|
|||||||
sm: 'h-8 px-3 text-xs',
|
sm: 'h-8 px-3 text-xs',
|
||||||
md: 'h-10 px-4 text-sm',
|
md: 'h-10 px-4 text-sm',
|
||||||
lg: 'h-12 px-5 text-base',
|
lg: 'h-12 px-5 text-base',
|
||||||
full: 'h-10 w-full px-4 text-sm'
|
full: 'h-10 w-full px-4 text-sm',
|
||||||
};
|
};
|
||||||
|
|
||||||
const ICON_ONLY_SIZE_CLASS: Record<ComponentSize, string> = {
|
const ICON_ONLY_SIZE_CLASS: Record<ComponentSize, string> = {
|
||||||
sm: 'h-8 w-8 !p-0',
|
sm: 'h-8 w-8 !p-0',
|
||||||
md: 'h-10 w-10 !p-0',
|
md: 'h-10 w-10 !p-0',
|
||||||
lg: 'h-12 w-12 !p-0',
|
lg: 'h-12 w-12 !p-0',
|
||||||
full: 'h-10 w-full !p-0'
|
full: 'h-10 w-full !p-0',
|
||||||
};
|
};
|
||||||
|
|
||||||
const ICON_CLASS: Record<ComponentSize, string> = {
|
const ICON_CLASS: Record<ComponentSize, string> = {
|
||||||
sm: 'h-4 w-4',
|
sm: 'h-4 w-4',
|
||||||
md: 'h-4 w-4',
|
md: 'h-4 w-4',
|
||||||
lg: 'h-5 w-5',
|
lg: 'h-5 w-5',
|
||||||
full: 'h-4 w-4'
|
full: 'h-4 w-4',
|
||||||
};
|
};
|
||||||
|
|
||||||
const ICON_ONLY_CLASS: Record<ComponentSize, string> = {
|
const ICON_ONLY_CLASS: Record<ComponentSize, string> = {
|
||||||
sm: 'h-4 w-4',
|
sm: 'h-4 w-4',
|
||||||
md: 'h-5 w-5',
|
md: 'h-5 w-5',
|
||||||
lg: 'h-6 w-6',
|
lg: 'h-6 w-6',
|
||||||
full: 'h-5 w-5'
|
full: 'h-5 w-5',
|
||||||
};
|
};
|
||||||
|
|
||||||
const TYPE_CLASS: Record<ButtonType, string> = {
|
const TYPE_CLASS: Record<ButtonType, string> = {
|
||||||
solid: 'btn-solid',
|
solid: 'btn-solid',
|
||||||
outlined: 'btn-outlined',
|
outlined: 'btn-outlined',
|
||||||
noborder: 'btn-noborder'
|
noborder: 'btn-noborder',
|
||||||
};
|
};
|
||||||
|
|
||||||
const VARIANT_CLASS: Record<ButtonVariant, string> = {
|
const VARIANT_CLASS: Record<ButtonVariant, string> = {
|
||||||
primary: 'btn-primary',
|
primary: 'btn-primary',
|
||||||
secondary: 'btn-secondary',
|
secondary: 'btn-secondary',
|
||||||
important: 'btn-important'
|
important: 'btn-important',
|
||||||
};
|
};
|
||||||
|
|
||||||
function resolveVariant(type: ButtonType, variant?: ButtonVariant): ButtonVariant {
|
function resolveVariant(type: ButtonType, variant?: ButtonVariant): ButtonVariant {
|
||||||
@@ -79,7 +79,7 @@ export function Button({
|
|||||||
disabled = false,
|
disabled = false,
|
||||||
icon: Icon,
|
icon: Icon,
|
||||||
ariaLabel,
|
ariaLabel,
|
||||||
className = ''
|
className = '',
|
||||||
}: Readonly<ButtonProps>) {
|
}: Readonly<ButtonProps>) {
|
||||||
const isIconOnly = Icon != null && !label;
|
const isIconOnly = Icon != null && !label;
|
||||||
const resolvedVariant = resolveVariant(type, variant);
|
const resolvedVariant = resolveVariant(type, variant);
|
||||||
@@ -89,8 +89,10 @@ export function Button({
|
|||||||
isIconOnly ? ICON_ONLY_SIZE_CLASS[size] : SIZE_CLASS[size],
|
isIconOnly ? ICON_ONLY_SIZE_CLASS[size] : SIZE_CLASS[size],
|
||||||
Icon && label ? 'gap-1.5' : '',
|
Icon && label ? 'gap-1.5' : '',
|
||||||
disabled ? 'pointer-events-none cursor-not-allowed opacity-45 saturate-50' : '',
|
disabled ? 'pointer-events-none cursor-not-allowed opacity-45 saturate-50' : '',
|
||||||
className
|
className,
|
||||||
].join(' ').trim();
|
]
|
||||||
|
.join(' ')
|
||||||
|
.trim();
|
||||||
const computedAriaLabel = ariaLabel ?? label;
|
const computedAriaLabel = ariaLabel ?? label;
|
||||||
const iconClass = `${isIconOnly ? ICON_ONLY_CLASS[size] : ICON_CLASS[size]} shrink-0`;
|
const iconClass = `${isIconOnly ? ICON_ONLY_CLASS[size] : ICON_CLASS[size]} shrink-0`;
|
||||||
const content = (
|
const content = (
|
||||||
|
|||||||
@@ -8,42 +8,44 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Compact badge/chip component with solid or outlined style. `tone` accepts a Tailwind color token (for example `cyan-700`) and resolves it to the correct border/background/text color at runtime.'
|
component:
|
||||||
}
|
'Compact badge/chip component with solid or outlined style. `tone` accepts a Tailwind color token (for example `cyan-700`) and resolves it to the correct border/background/text color at runtime.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
variant: {
|
variant: {
|
||||||
description: 'Chip visual style.',
|
description: 'Chip visual style.',
|
||||||
options: ['solid', 'outlined'],
|
options: ['solid', 'outlined'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'solid' | 'outlined'" } }
|
table: { type: { summary: "'solid' | 'outlined'" } },
|
||||||
},
|
},
|
||||||
tone: {
|
tone: {
|
||||||
description: 'Tailwind color token (format: `<color>-<shade>`, for example `cyan-700`, `indigo-600`, `rose-500`).',
|
description:
|
||||||
|
'Tailwind color token (format: `<color>-<shade>`, for example `cyan-700`, `indigo-600`, `rose-500`).',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
as: {
|
as: {
|
||||||
description: "Root tag or component to render (for example `'span'`, `'a'`, `'button'`).",
|
description: "Root tag or component to render (for example `'span'`, `'a'`, `'button'`).",
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ElementType' } }
|
table: { type: { summary: 'ElementType' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the root element.',
|
description: 'Extra CSS classes for the root element.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
children: {
|
children: {
|
||||||
description: 'Text or React node rendered inside the chip.',
|
description: 'Text or React node rendered inside the chip.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'ReactNode' } }
|
table: { type: { summary: 'ReactNode' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
children: 'Published',
|
children: 'Published',
|
||||||
variant: 'solid'
|
variant: 'solid',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof Chip>;
|
} satisfies Meta<typeof Chip>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -55,29 +57,41 @@ export const OutlinedIndigo: Story = {
|
|||||||
args: {
|
args: {
|
||||||
variant: 'outlined',
|
variant: 'outlined',
|
||||||
tone: 'indigo-700',
|
tone: 'indigo-700',
|
||||||
children: 'Draft'
|
children: 'Draft',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const OutlinedCyan: Story = {
|
export const OutlinedCyan: Story = {
|
||||||
args: {
|
args: {
|
||||||
variant: 'outlined',
|
variant: 'outlined',
|
||||||
tone: 'cyan-700',
|
tone: 'cyan-700',
|
||||||
children: 'Archived'
|
children: 'Archived',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const ToneMatrix: Story = {
|
export const ToneMatrix: Story = {
|
||||||
render: () => (
|
render: () => (
|
||||||
<div className="flex flex-wrap items-center gap-2">
|
<div className="flex flex-wrap items-center gap-2">
|
||||||
<Chip variant="solid">Default</Chip>
|
<Chip variant="solid">Default</Chip>
|
||||||
<Chip variant="solid" tone="indigo-700">Indigo</Chip>
|
<Chip variant="solid" tone="indigo-700">
|
||||||
<Chip variant="solid" tone="cyan-700">Cyan</Chip>
|
Indigo
|
||||||
<Chip variant="solid" tone="rose-600">Rose</Chip>
|
</Chip>
|
||||||
|
<Chip variant="solid" tone="cyan-700">
|
||||||
|
Cyan
|
||||||
|
</Chip>
|
||||||
|
<Chip variant="solid" tone="rose-600">
|
||||||
|
Rose
|
||||||
|
</Chip>
|
||||||
<Chip variant="outlined">Default</Chip>
|
<Chip variant="outlined">Default</Chip>
|
||||||
<Chip variant="outlined" tone="indigo-700">Indigo</Chip>
|
<Chip variant="outlined" tone="indigo-700">
|
||||||
<Chip variant="outlined" tone="cyan-700">Cyan</Chip>
|
Indigo
|
||||||
<Chip variant="outlined" tone="rose-600">Rose</Chip>
|
</Chip>
|
||||||
|
<Chip variant="outlined" tone="cyan-700">
|
||||||
|
Cyan
|
||||||
|
</Chip>
|
||||||
|
<Chip variant="outlined" tone="rose-600">
|
||||||
|
Rose
|
||||||
|
</Chip>
|
||||||
</div>
|
</div>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ type ChipProps<T extends ElementType> = {
|
|||||||
|
|
||||||
const variantClassMap: Record<ChipVariant, string> = {
|
const variantClassMap: Record<ChipVariant, string> = {
|
||||||
solid: 'chip-solid',
|
solid: 'chip-solid',
|
||||||
outlined: 'chip-outlined'
|
outlined: 'chip-outlined',
|
||||||
};
|
};
|
||||||
|
|
||||||
type TailwindPalette = Record<string, string>;
|
type TailwindPalette = Record<string, string>;
|
||||||
@@ -50,16 +50,21 @@ export function Chip<T extends ElementType = 'span'>({
|
|||||||
tone,
|
tone,
|
||||||
as,
|
as,
|
||||||
className = '',
|
className = '',
|
||||||
children
|
children,
|
||||||
}: Readonly<ChipProps<T>>) {
|
}: Readonly<ChipProps<T>>) {
|
||||||
const Component = as ?? 'span' as ElementType;
|
const Component = as ?? ('span' as ElementType);
|
||||||
const toneColor = resolveTailwindToneColor(tone);
|
const toneColor = resolveTailwindToneColor(tone);
|
||||||
const toneStyle: CSSProperties | undefined = toneColor == null
|
const toneStyle: CSSProperties | undefined =
|
||||||
? undefined
|
toneColor == null
|
||||||
: variant === 'solid'
|
? undefined
|
||||||
? { borderColor: toneColor, backgroundColor: toneColor, color: '#ffffff' }
|
: variant === 'solid'
|
||||||
: { borderColor: toneColor, color: toneColor };
|
? { borderColor: toneColor, backgroundColor: toneColor, color: '#ffffff' }
|
||||||
|
: { borderColor: toneColor, color: toneColor };
|
||||||
const classes = `chip-root ${variantClassMap[variant]} ${className}`.trim();
|
const classes = `chip-root ${variantClassMap[variant]} ${className}`.trim();
|
||||||
|
|
||||||
return <Component className={classes} style={toneStyle}>{children}</Component>;
|
return (
|
||||||
|
<Component className={classes} style={toneStyle}>
|
||||||
|
{children}
|
||||||
|
</Component>
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import { Dropdown } from './Dropdown';
|
|||||||
const choices = [
|
const choices = [
|
||||||
{ id: 'draft', label: 'Draft' },
|
{ id: 'draft', label: 'Draft' },
|
||||||
{ id: 'review', label: 'In review' },
|
{ id: 'review', label: 'In review' },
|
||||||
{ id: 'published', label: 'Published' }
|
{ id: 'published', label: 'Published' },
|
||||||
];
|
];
|
||||||
|
|
||||||
const meta = {
|
const meta = {
|
||||||
@@ -15,76 +15,77 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Styled select component with label, error state, stacked/inline layout, and multiple sizes.'
|
component:
|
||||||
}
|
'Styled select component with label, error state, stacked/inline layout, and multiple sizes.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
label: {
|
label: {
|
||||||
description: 'Label text shown above (stacked) or on the left (inline).',
|
description: 'Label text shown above (stacked) or on the left (inline).',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
value: {
|
value: {
|
||||||
description: 'Current selected value (must match one `choices[].id`).',
|
description: 'Current selected value (must match one `choices[].id`).',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
choices: {
|
choices: {
|
||||||
description: "Options list in `{ id: string; label: string }` format.",
|
description: 'Options list in `{ id: string; label: string }` format.',
|
||||||
control: 'object',
|
control: 'object',
|
||||||
table: { type: { summary: 'Array<{ id: string; label: string }>' } }
|
table: { type: { summary: 'Array<{ id: string; label: string }>' } },
|
||||||
},
|
},
|
||||||
size: {
|
size: {
|
||||||
description: 'Control size.',
|
description: 'Control size.',
|
||||||
options: ['sm', 'md', 'lg', 'full'],
|
options: ['sm', 'md', 'lg', 'full'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } }
|
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } },
|
||||||
},
|
},
|
||||||
layout: {
|
layout: {
|
||||||
description: 'Label/control layout mode.',
|
description: 'Label/control layout mode.',
|
||||||
options: ['stacked', 'inline'],
|
options: ['stacked', 'inline'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'stacked' | 'inline'" } }
|
table: { type: { summary: "'stacked' | 'inline'" } },
|
||||||
},
|
},
|
||||||
disabled: {
|
disabled: {
|
||||||
description: 'Disables the field.',
|
description: 'Disables the field.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
required: {
|
required: {
|
||||||
description: 'Sets the native HTML `required` attribute.',
|
description: 'Sets the native HTML `required` attribute.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
error: {
|
error: {
|
||||||
description: 'Error message shown below the field.',
|
description: 'Error message shown below the field.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the wrapper.',
|
description: 'Extra CSS classes for the wrapper.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
selectClassName: {
|
selectClassName: {
|
||||||
description: 'Extra CSS classes for the `<select>` element.',
|
description: 'Extra CSS classes for the `<select>` element.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
onChange: {
|
onChange: {
|
||||||
description: 'Callback fired with the newly selected value.',
|
description: 'Callback fired with the newly selected value.',
|
||||||
action: 'changed',
|
action: 'changed',
|
||||||
table: { type: { summary: '(value: string) => void' } }
|
table: { type: { summary: '(value: string) => void' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
label: 'Status',
|
label: 'Status',
|
||||||
value: 'draft',
|
value: 'draft',
|
||||||
choices,
|
choices,
|
||||||
size: 'md',
|
size: 'md',
|
||||||
layout: 'stacked'
|
layout: 'stacked',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof Dropdown>;
|
} satisfies Meta<typeof Dropdown>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -103,13 +104,13 @@ export const Stacked: Story = {
|
|||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Inline: Story = {
|
export const Inline: Story = {
|
||||||
args: {
|
args: {
|
||||||
layout: 'inline',
|
layout: 'inline',
|
||||||
size: 'sm'
|
size: 'sm',
|
||||||
},
|
},
|
||||||
render: (args) => {
|
render: (args) => {
|
||||||
const [value, setValue] = useState(args.value);
|
const [value, setValue] = useState(args.value);
|
||||||
@@ -123,19 +124,19 @@ export const Inline: Story = {
|
|||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Disabled: Story = {
|
export const Disabled: Story = {
|
||||||
args: {
|
args: {
|
||||||
disabled: true
|
disabled: true,
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const WithError: Story = {
|
export const WithError: Story = {
|
||||||
args: {
|
args: {
|
||||||
error: 'Please choose a valid status'
|
error: 'Please choose a valid status',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const SizeMatrix: Story = {
|
export const SizeMatrix: Story = {
|
||||||
@@ -149,5 +150,5 @@ export const SizeMatrix: Story = {
|
|||||||
<Dropdown {...args} value={value} size="full" label="Full" onChange={setValue} />
|
<Dropdown {...args} value={value} size="full" label="Full" onChange={setValue} />
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -34,35 +34,36 @@ export function Dropdown({
|
|||||||
onChange,
|
onChange,
|
||||||
error,
|
error,
|
||||||
className = '',
|
className = '',
|
||||||
selectClassName = ''
|
selectClassName = '',
|
||||||
}: Readonly<DropdownProps>) {
|
}: Readonly<DropdownProps>) {
|
||||||
const containerSizeClass = {
|
const containerSizeClass = {
|
||||||
sm: 'max-w-xs',
|
sm: 'max-w-xs',
|
||||||
md: 'max-w-sm',
|
md: 'max-w-sm',
|
||||||
lg: 'max-w-md',
|
lg: 'max-w-md',
|
||||||
full: 'max-w-none'
|
full: 'max-w-none',
|
||||||
}[size];
|
}[size];
|
||||||
|
|
||||||
const selectSizeClass = {
|
const selectSizeClass = {
|
||||||
sm: 'h-8 !text-xs',
|
sm: 'h-8 !text-xs',
|
||||||
md: 'h-10 text-sm',
|
md: 'h-10 text-sm',
|
||||||
lg: 'h-12 text-sm',
|
lg: 'h-12 text-sm',
|
||||||
full: 'h-10 text-sm'
|
full: 'h-10 text-sm',
|
||||||
}[size];
|
}[size];
|
||||||
|
|
||||||
const handleChange: ChangeEventHandler<HTMLSelectElement> = (event) => {
|
const handleChange: ChangeEventHandler<HTMLSelectElement> = (event) => {
|
||||||
onChange?.(event.target.value);
|
onChange?.(event.target.value);
|
||||||
};
|
};
|
||||||
|
|
||||||
const wrapperClass = layout === 'inline'
|
const wrapperClass =
|
||||||
? 'inline-flex w-auto items-center gap-2'
|
layout === 'inline' ? 'inline-flex w-auto items-center gap-2' : 'block w-full gap-1';
|
||||||
: 'block w-full gap-1';
|
|
||||||
|
|
||||||
const selectWrapperClass = layout === 'inline' ? 'relative' : 'relative mt-1';
|
const selectWrapperClass = layout === 'inline' ? 'relative' : 'relative mt-1';
|
||||||
const labelClass = layout === 'inline' ? 'text-xs ui-body-secondary' : '';
|
const labelClass = layout === 'inline' ? 'text-xs ui-body-secondary' : '';
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<label className={`${wrapperClass} text-sm font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'} ${containerSizeClass} ${className}`.trim()}>
|
<label
|
||||||
|
className={`${wrapperClass} text-sm font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'} ${containerSizeClass} ${className}`.trim()}
|
||||||
|
>
|
||||||
{label ? <span className={labelClass}>{label}</span> : null}
|
{label ? <span className={labelClass}>{label}</span> : null}
|
||||||
<div className={selectWrapperClass}>
|
<div className={selectWrapperClass}>
|
||||||
<select
|
<select
|
||||||
@@ -78,11 +79,17 @@ export function Dropdown({
|
|||||||
</option>
|
</option>
|
||||||
))}
|
))}
|
||||||
</select>
|
</select>
|
||||||
<span className={`pointer-events-none absolute inset-y-0 right-3 flex items-center ${disabled ? 'ui-label-disabled' : 'ui-body-secondary'}`}>
|
<span
|
||||||
|
className={`pointer-events-none absolute inset-y-0 right-3 flex items-center ${disabled ? 'ui-label-disabled' : 'ui-body-secondary'}`}
|
||||||
|
>
|
||||||
<ChevronDownIcon className="h-4 w-4" aria-hidden="true" />
|
<ChevronDownIcon className="h-4 w-4" aria-hidden="true" />
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
{error ? <span className="mt-1 block text-xs" style={{ color: 'var(--error-text)' }}>{error}</span> : null}
|
{error ? (
|
||||||
|
<span className="mt-1 block text-xs" style={{ color: 'var(--error-text)' }}>
|
||||||
|
{error}
|
||||||
|
</span>
|
||||||
|
) : null}
|
||||||
</label>
|
</label>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,35 +12,36 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Surface container with a title bar and a responsive content grid, intended for CMS forms.'
|
component:
|
||||||
}
|
'Surface container with a title bar and a responsive content grid, intended for CMS forms.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
title: {
|
title: {
|
||||||
description: 'Form title displayed in the header bar.',
|
description: 'Form title displayed in the header bar.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
titleBarRight: {
|
titleBarRight: {
|
||||||
description: 'Optional node rendered on the right side of the title bar.',
|
description: 'Optional node rendered on the right side of the title bar.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ReactNode' } }
|
table: { type: { summary: 'ReactNode' } },
|
||||||
},
|
},
|
||||||
children: {
|
children: {
|
||||||
description: 'Form content rendered inside the responsive grid.',
|
description: 'Form content rendered inside the responsive grid.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ReactNode' } }
|
table: { type: { summary: 'ReactNode' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the root container.',
|
description: 'Extra CSS classes for the root container.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
title: 'Post details'
|
title: 'Post details',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof Form>;
|
} satisfies Meta<typeof Form>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -56,13 +57,13 @@ export const Basic: Story = {
|
|||||||
value="draft"
|
value="draft"
|
||||||
choices={[
|
choices={[
|
||||||
{ id: 'draft', label: 'Draft' },
|
{ id: 'draft', label: 'Draft' },
|
||||||
{ id: 'published', label: 'Published' }
|
{ id: 'published', label: 'Published' },
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
<InputField label="Slug" type="text" value="a-short-post-title" />
|
<InputField label="Slug" type="text" value="a-short-post-title" />
|
||||||
</>
|
</>
|
||||||
)
|
),
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const WithActions: Story = {
|
export const WithActions: Story = {
|
||||||
@@ -71,10 +72,7 @@ export const WithActions: Story = {
|
|||||||
const [status, setStatus] = useState('draft');
|
const [status, setStatus] = useState('draft');
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<Form
|
<Form {...args} titleBarRight={<Button type="solid" size="sm" label="Save" />}>
|
||||||
{...args}
|
|
||||||
titleBarRight={<Button type="solid" size="sm" label="Save" />}
|
|
||||||
>
|
|
||||||
<div className="col-span-2">
|
<div className="col-span-2">
|
||||||
<InputField
|
<InputField
|
||||||
label="Title"
|
label="Title"
|
||||||
@@ -91,11 +89,11 @@ export const WithActions: Story = {
|
|||||||
choices={[
|
choices={[
|
||||||
{ id: 'draft', label: 'Draft' },
|
{ id: 'draft', label: 'Draft' },
|
||||||
{ id: 'review', label: 'In review' },
|
{ id: 'review', label: 'In review' },
|
||||||
{ id: 'published', label: 'Published' }
|
{ id: 'published', label: 'Published' },
|
||||||
]}
|
]}
|
||||||
/>
|
/>
|
||||||
<InputField label="Slug" type="text" value="storybook-powered-cms" />
|
<InputField label="Slug" type="text" value="storybook-powered-cms" />
|
||||||
</Form>
|
</Form>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -11,14 +11,15 @@ type FormProps = {
|
|||||||
export function Form({ title, titleBarRight, children, className = '' }: Readonly<FormProps>) {
|
export function Form({ title, titleBarRight, children, className = '' }: Readonly<FormProps>) {
|
||||||
return (
|
return (
|
||||||
<div className={`surface overflow-hidden rounded-xl ${className}`.trim()}>
|
<div className={`surface overflow-hidden rounded-xl ${className}`.trim()}>
|
||||||
<div className="flex items-center justify-between border-b px-4 py-3 sm:px-5" style={{ borderColor: 'var(--surface-divider)' }}>
|
<div
|
||||||
|
className="flex items-center justify-between border-b px-4 py-3 sm:px-5"
|
||||||
|
style={{ borderColor: 'var(--surface-divider)' }}
|
||||||
|
>
|
||||||
<Label variant="h4">{title}</Label>
|
<Label variant="h4">{title}</Label>
|
||||||
{titleBarRight ? <div>{titleBarRight}</div> : null}
|
{titleBarRight ? <div>{titleBarRight}</div> : null}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div className="grid grid-cols-1 gap-4 p-4 sm:p-5 lg:grid-cols-3">
|
<div className="grid grid-cols-1 gap-4 p-4 sm:p-5 lg:grid-cols-3">{children}</div>
|
||||||
{children}
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,94 +10,96 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Text input field with optional label, validation state, size/layout variants, and password visibility toggle.'
|
component:
|
||||||
}
|
'Text input field with optional label, validation state, size/layout variants, and password visibility toggle.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
label: {
|
label: {
|
||||||
description: 'Label text shown above (stacked) or on the left (inline).',
|
description: 'Label text shown above (stacked) or on the left (inline).',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
placeholder: {
|
placeholder: {
|
||||||
description: 'Input placeholder text.',
|
description: 'Input placeholder text.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
type: {
|
type: {
|
||||||
description: 'Native input type.',
|
description: 'Native input type.',
|
||||||
options: ['text', 'password', 'email'],
|
options: ['text', 'password', 'email'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'text' | 'password' | 'email'" } }
|
table: { type: { summary: "'text' | 'password' | 'email'" } },
|
||||||
},
|
},
|
||||||
size: {
|
size: {
|
||||||
description: 'Input size.',
|
description: 'Input size.',
|
||||||
options: ['sm', 'md', 'lg', 'full'],
|
options: ['sm', 'md', 'lg', 'full'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } }
|
table: { type: { summary: "'sm' | 'md' | 'lg' | 'full'" } },
|
||||||
},
|
},
|
||||||
layout: {
|
layout: {
|
||||||
description: 'Label/input layout mode.',
|
description: 'Label/input layout mode.',
|
||||||
options: ['stacked', 'inline'],
|
options: ['stacked', 'inline'],
|
||||||
control: 'inline-radio',
|
control: 'inline-radio',
|
||||||
table: { type: { summary: "'stacked' | 'inline'" } }
|
table: { type: { summary: "'stacked' | 'inline'" } },
|
||||||
},
|
},
|
||||||
value: {
|
value: {
|
||||||
description: 'Controlled input value.',
|
description: 'Controlled input value.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
name: {
|
name: {
|
||||||
description: 'Native input `name` attribute.',
|
description: 'Native input `name` attribute.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
disabled: {
|
disabled: {
|
||||||
description: 'Disables the input.',
|
description: 'Disables the input.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
required: {
|
required: {
|
||||||
description: 'Sets the native HTML `required` attribute.',
|
description: 'Sets the native HTML `required` attribute.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
error: {
|
error: {
|
||||||
description: 'Validation message shown below the field.',
|
description: 'Validation message shown below the field.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
rightIcon: {
|
rightIcon: {
|
||||||
description: 'Optional trailing icon node (ignored for password type because toggle icon is used).',
|
description:
|
||||||
|
'Optional trailing icon node (ignored for password type because toggle icon is used).',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ReactNode' } }
|
table: { type: { summary: 'ReactNode' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the outer wrapper.',
|
description: 'Extra CSS classes for the outer wrapper.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
inputClassName: {
|
inputClassName: {
|
||||||
description: 'Extra CSS classes for the `<input>` element.',
|
description: 'Extra CSS classes for the `<input>` element.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
onChange: {
|
onChange: {
|
||||||
description: 'Change handler callback.',
|
description: 'Change handler callback.',
|
||||||
action: 'changed',
|
action: 'changed',
|
||||||
table: { type: { summary: 'ChangeEventHandler<HTMLInputElement>' } }
|
table: { type: { summary: 'ChangeEventHandler<HTMLInputElement>' } },
|
||||||
},
|
},
|
||||||
onBlur: {
|
onBlur: {
|
||||||
description: 'Blur handler callback.',
|
description: 'Blur handler callback.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'FocusEventHandler<HTMLInputElement>' } }
|
table: { type: { summary: 'FocusEventHandler<HTMLInputElement>' } },
|
||||||
},
|
},
|
||||||
inputRef: {
|
inputRef: {
|
||||||
description: 'Ref forwarded to the native `<input>` element.',
|
description: 'Ref forwarded to the native `<input>` element.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'Ref<HTMLInputElement>' } }
|
table: { type: { summary: 'Ref<HTMLInputElement>' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
label: 'Email',
|
label: 'Email',
|
||||||
@@ -105,8 +107,8 @@ const meta = {
|
|||||||
placeholder: 'name@example.com',
|
placeholder: 'name@example.com',
|
||||||
value: '',
|
value: '',
|
||||||
size: 'md',
|
size: 'md',
|
||||||
layout: 'stacked'
|
layout: 'stacked',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof InputField>;
|
} satisfies Meta<typeof InputField>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -116,7 +118,7 @@ export const Text: Story = {
|
|||||||
args: {
|
args: {
|
||||||
type: 'text',
|
type: 'text',
|
||||||
label: 'Title',
|
label: 'Title',
|
||||||
placeholder: 'Write a title'
|
placeholder: 'Write a title',
|
||||||
},
|
},
|
||||||
render: (args) => {
|
render: (args) => {
|
||||||
const [value, setValue] = useState('Storybook integration');
|
const [value, setValue] = useState('Storybook integration');
|
||||||
@@ -130,14 +132,14 @@ export const Text: Story = {
|
|||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const PasswordWithToggle: Story = {
|
export const PasswordWithToggle: Story = {
|
||||||
args: {
|
args: {
|
||||||
type: 'password',
|
type: 'password',
|
||||||
label: 'Password',
|
label: 'Password',
|
||||||
placeholder: 'Type a strong password'
|
placeholder: 'Type a strong password',
|
||||||
},
|
},
|
||||||
render: (args) => {
|
render: (args) => {
|
||||||
const [value, setValue] = useState('pa55word');
|
const [value, setValue] = useState('pa55word');
|
||||||
@@ -151,7 +153,7 @@ export const PasswordWithToggle: Story = {
|
|||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const InlineWithIcon: Story = {
|
export const InlineWithIcon: Story = {
|
||||||
@@ -160,7 +162,7 @@ export const InlineWithIcon: Story = {
|
|||||||
label: 'Search',
|
label: 'Search',
|
||||||
layout: 'inline',
|
layout: 'inline',
|
||||||
size: 'sm',
|
size: 'sm',
|
||||||
rightIcon: <MagnifyingGlassIcon className="h-4 w-4 ui-body-secondary" />
|
rightIcon: <MagnifyingGlassIcon className="h-4 w-4 ui-body-secondary" />,
|
||||||
},
|
},
|
||||||
render: (args) => {
|
render: (args) => {
|
||||||
const [value, setValue] = useState('posts');
|
const [value, setValue] = useState('posts');
|
||||||
@@ -174,7 +176,7 @@ export const InlineWithIcon: Story = {
|
|||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Error: Story = {
|
export const Error: Story = {
|
||||||
@@ -182,8 +184,8 @@ export const Error: Story = {
|
|||||||
type: 'email',
|
type: 'email',
|
||||||
label: 'Email',
|
label: 'Email',
|
||||||
value: 'invalid.mail',
|
value: 'invalid.mail',
|
||||||
error: 'Enter a valid email address'
|
error: 'Enter a valid email address',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Disabled: Story = {
|
export const Disabled: Story = {
|
||||||
@@ -191,25 +193,45 @@ export const Disabled: Story = {
|
|||||||
type: 'text',
|
type: 'text',
|
||||||
label: 'Read only field',
|
label: 'Read only field',
|
||||||
value: 'Locked content',
|
value: 'Locked content',
|
||||||
disabled: true
|
disabled: true,
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const SizeMatrix: Story = {
|
export const SizeMatrix: Story = {
|
||||||
args: {
|
args: {
|
||||||
type: 'text',
|
type: 'text',
|
||||||
label: 'Name',
|
label: 'Name',
|
||||||
placeholder: 'Enter value'
|
placeholder: 'Enter value',
|
||||||
},
|
},
|
||||||
render: (args) => {
|
render: (args) => {
|
||||||
const [value, setValue] = useState('Beatrice');
|
const [value, setValue] = useState('Beatrice');
|
||||||
return (
|
return (
|
||||||
<div className="grid grid-cols-1 gap-3">
|
<div className="grid grid-cols-1 gap-3">
|
||||||
<InputField {...args} value={value} size="sm" onChange={(event) => setValue(event.target.value)} />
|
<InputField
|
||||||
<InputField {...args} value={value} size="md" onChange={(event) => setValue(event.target.value)} />
|
{...args}
|
||||||
<InputField {...args} value={value} size="lg" onChange={(event) => setValue(event.target.value)} />
|
value={value}
|
||||||
<InputField {...args} value={value} size="full" onChange={(event) => setValue(event.target.value)} />
|
size="sm"
|
||||||
|
onChange={(event) => setValue(event.target.value)}
|
||||||
|
/>
|
||||||
|
<InputField
|
||||||
|
{...args}
|
||||||
|
value={value}
|
||||||
|
size="md"
|
||||||
|
onChange={(event) => setValue(event.target.value)}
|
||||||
|
/>
|
||||||
|
<InputField
|
||||||
|
{...args}
|
||||||
|
value={value}
|
||||||
|
size="lg"
|
||||||
|
onChange={(event) => setValue(event.target.value)}
|
||||||
|
/>
|
||||||
|
<InputField
|
||||||
|
{...args}
|
||||||
|
value={value}
|
||||||
|
size="full"
|
||||||
|
onChange={(event) => setValue(event.target.value)}
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -42,26 +42,25 @@ export function InputField({
|
|||||||
error,
|
error,
|
||||||
rightIcon,
|
rightIcon,
|
||||||
className = '',
|
className = '',
|
||||||
inputClassName = ''
|
inputClassName = '',
|
||||||
}: Readonly<InputFieldProps>) {
|
}: Readonly<InputFieldProps>) {
|
||||||
const [showPassword, setShowPassword] = useState(false);
|
const [showPassword, setShowPassword] = useState(false);
|
||||||
const containerSizeClass = {
|
const containerSizeClass = {
|
||||||
sm: 'max-w-xs',
|
sm: 'max-w-xs',
|
||||||
md: 'max-w-sm',
|
md: 'max-w-sm',
|
||||||
lg: 'max-w-md',
|
lg: 'max-w-md',
|
||||||
full: 'max-w-none'
|
full: 'max-w-none',
|
||||||
}[size];
|
}[size];
|
||||||
|
|
||||||
const inputSizeClass = {
|
const inputSizeClass = {
|
||||||
sm: 'h-8 !text-xs',
|
sm: 'h-8 !text-xs',
|
||||||
md: 'h-10 text-sm',
|
md: 'h-10 text-sm',
|
||||||
lg: 'h-12 text-sm',
|
lg: 'h-12 text-sm',
|
||||||
full: 'h-10 text-sm'
|
full: 'h-10 text-sm',
|
||||||
}[size];
|
}[size];
|
||||||
|
|
||||||
const wrapperClass = layout === 'inline'
|
const wrapperClass =
|
||||||
? 'inline-flex w-auto items-center gap-2'
|
layout === 'inline' ? 'inline-flex w-auto items-center gap-2' : 'block w-full gap-1';
|
||||||
: 'block w-full gap-1';
|
|
||||||
const labelClass = layout === 'inline' ? 'text-xs ui-body-secondary' : '';
|
const labelClass = layout === 'inline' ? 'text-xs ui-body-secondary' : '';
|
||||||
const isPasswordType = type === 'password';
|
const isPasswordType = type === 'password';
|
||||||
const resolvedType: InputKind = isPasswordType && showPassword ? 'text' : type;
|
const resolvedType: InputKind = isPasswordType && showPassword ? 'text' : type;
|
||||||
@@ -69,7 +68,9 @@ export function InputField({
|
|||||||
const inputWrapperClass = layout === 'inline' ? 'relative' : 'relative mt-1';
|
const inputWrapperClass = layout === 'inline' ? 'relative' : 'relative mt-1';
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<label className={`${wrapperClass} text-sm font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'} ${containerSizeClass} ${className}`.trim()}>
|
<label
|
||||||
|
className={`${wrapperClass} text-sm font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'} ${containerSizeClass} ${className}`.trim()}
|
||||||
|
>
|
||||||
{label ? <span className={labelClass}>{label}</span> : null}
|
{label ? <span className={labelClass}>{label}</span> : null}
|
||||||
<div className={inputWrapperClass}>
|
<div className={inputWrapperClass}>
|
||||||
<input
|
<input
|
||||||
@@ -100,7 +101,11 @@ export function InputField({
|
|||||||
</span>
|
</span>
|
||||||
) : null}
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
{error ? <span className="mt-1 block text-xs" style={{ color: 'var(--error-text)' }}>{error}</span> : null}
|
{error ? (
|
||||||
|
<span className="mt-1 block text-xs" style={{ color: 'var(--error-text)' }}>
|
||||||
|
{error}
|
||||||
|
</span>
|
||||||
|
) : null}
|
||||||
</label>
|
</label>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,37 +8,42 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Typography helper component for headings, body text, caption, error text, and inline code styles.'
|
component:
|
||||||
}
|
'Typography helper component for headings, body text, caption, error text, and inline code styles.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
variant: {
|
variant: {
|
||||||
description: 'Typography style preset.',
|
description: 'Typography style preset.',
|
||||||
options: ['h1', 'h2', 'h3', 'h4', 'body', 'body2', 'caption', 'error', 'code'],
|
options: ['h1', 'h2', 'h3', 'h4', 'body', 'body2', 'caption', 'error', 'code'],
|
||||||
control: 'select',
|
control: 'select',
|
||||||
table: { type: { summary: "'h1' | 'h2' | 'h3' | 'h4' | 'body' | 'body2' | 'caption' | 'error' | 'code'" } }
|
table: {
|
||||||
|
type: {
|
||||||
|
summary: "'h1' | 'h2' | 'h3' | 'h4' | 'body' | 'body2' | 'caption' | 'error' | 'code'",
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
as: {
|
as: {
|
||||||
description: "Override rendered HTML tag or component (for example `'p'`, `'span'`, `'h2'`).",
|
description: "Override rendered HTML tag or component (for example `'p'`, `'span'`, `'h2'`).",
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ElementType' } }
|
table: { type: { summary: 'ElementType' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes.',
|
description: 'Extra CSS classes.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
children: {
|
children: {
|
||||||
description: 'Label content.',
|
description: 'Label content.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'ReactNode' } }
|
table: { type: { summary: 'ReactNode' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
variant: 'body',
|
variant: 'body',
|
||||||
children: 'Label text'
|
children: 'Label text',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof Label>;
|
} satisfies Meta<typeof Label>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -49,15 +54,15 @@ export const Body: Story = {};
|
|||||||
export const Error: Story = {
|
export const Error: Story = {
|
||||||
args: {
|
args: {
|
||||||
variant: 'error',
|
variant: 'error',
|
||||||
children: 'This field is required'
|
children: 'This field is required',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Code: Story = {
|
export const Code: Story = {
|
||||||
args: {
|
args: {
|
||||||
variant: 'code',
|
variant: 'code',
|
||||||
children: 'const isPublished = true;'
|
children: 'const isPublished = true;',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const VariantScale: Story = {
|
export const VariantScale: Story = {
|
||||||
@@ -73,5 +78,5 @@ export const VariantScale: Story = {
|
|||||||
<Label variant="error">Error copy</Label>
|
<Label variant="error">Error copy</Label>
|
||||||
<Label variant="code">npm run build</Label>
|
<Label variant="code">npm run build</Label>
|
||||||
</div>
|
</div>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,15 +1,6 @@
|
|||||||
import type { ElementType, ReactNode } from 'react';
|
import type { ElementType, ReactNode } from 'react';
|
||||||
|
|
||||||
type LabelVariant =
|
type LabelVariant = 'h1' | 'h2' | 'h3' | 'h4' | 'body' | 'body2' | 'caption' | 'error' | 'code';
|
||||||
| 'h1'
|
|
||||||
| 'h2'
|
|
||||||
| 'h3'
|
|
||||||
| 'h4'
|
|
||||||
| 'body'
|
|
||||||
| 'body2'
|
|
||||||
| 'caption'
|
|
||||||
| 'error'
|
|
||||||
| 'code';
|
|
||||||
|
|
||||||
type LabelProps<T extends ElementType> = {
|
type LabelProps<T extends ElementType> = {
|
||||||
variant?: LabelVariant;
|
variant?: LabelVariant;
|
||||||
@@ -27,7 +18,7 @@ const variantClassMap: Record<LabelVariant, string> = {
|
|||||||
body2: 'ui-body-secondary text-sm',
|
body2: 'ui-body-secondary text-sm',
|
||||||
caption: 'ui-kicker text-xs font-semibold uppercase tracking-[0.12em]',
|
caption: 'ui-kicker text-xs font-semibold uppercase tracking-[0.12em]',
|
||||||
error: 'ui-error text-sm',
|
error: 'ui-error text-sm',
|
||||||
code: 'ui-code text-sm font-mono'
|
code: 'ui-code text-sm font-mono',
|
||||||
};
|
};
|
||||||
|
|
||||||
const variantTagMap: Record<LabelVariant, ElementType> = {
|
const variantTagMap: Record<LabelVariant, ElementType> = {
|
||||||
@@ -39,14 +30,14 @@ const variantTagMap: Record<LabelVariant, ElementType> = {
|
|||||||
body2: 'p',
|
body2: 'p',
|
||||||
caption: 'p',
|
caption: 'p',
|
||||||
error: 'p',
|
error: 'p',
|
||||||
code: 'code'
|
code: 'code',
|
||||||
};
|
};
|
||||||
|
|
||||||
export function Label<T extends ElementType = 'p'>({
|
export function Label<T extends ElementType = 'p'>({
|
||||||
variant = 'body',
|
variant = 'body',
|
||||||
as,
|
as,
|
||||||
className = '',
|
className = '',
|
||||||
children
|
children,
|
||||||
}: Readonly<LabelProps<T>>) {
|
}: Readonly<LabelProps<T>>) {
|
||||||
const Component = as ?? variantTagMap[variant];
|
const Component = as ?? variantTagMap[variant];
|
||||||
const classes = `${variantClassMap[variant]} ${className}`.trim();
|
const classes = `${variantClassMap[variant]} ${className}`.trim();
|
||||||
|
|||||||
@@ -1,14 +1,14 @@
|
|||||||
import { useState } from 'react';
|
import { useState } from 'react';
|
||||||
import type { Meta, StoryObj } from '@storybook/react';
|
import type { Meta, StoryObj } from '@storybook/react';
|
||||||
import { headingsPlugin, listsPlugin, markdownShortcutPlugin, quotePlugin } from '@mdxeditor/editor';
|
import {
|
||||||
|
headingsPlugin,
|
||||||
|
listsPlugin,
|
||||||
|
markdownShortcutPlugin,
|
||||||
|
quotePlugin,
|
||||||
|
} from '@mdxeditor/editor';
|
||||||
import { MDXEditorField } from './MDXEditorField';
|
import { MDXEditorField } from './MDXEditorField';
|
||||||
|
|
||||||
const basePlugins = [
|
const basePlugins = [headingsPlugin(), listsPlugin(), quotePlugin(), markdownShortcutPlugin()];
|
||||||
headingsPlugin(),
|
|
||||||
listsPlugin(),
|
|
||||||
quotePlugin(),
|
|
||||||
markdownShortcutPlugin()
|
|
||||||
];
|
|
||||||
|
|
||||||
const sampleMarkdown = `# Hello from MDXEditor
|
const sampleMarkdown = `# Hello from MDXEditor
|
||||||
|
|
||||||
@@ -25,88 +25,89 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'MDX editor wrapper with label, editable/read-only/disabled modes, theme class support, and error rendering.'
|
component:
|
||||||
}
|
'MDX editor wrapper with label, editable/read-only/disabled modes, theme class support, and error rendering.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
label: {
|
label: {
|
||||||
description: 'Field label shown above the editor.',
|
description: 'Field label shown above the editor.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
markdown: {
|
markdown: {
|
||||||
description: 'Controlled markdown content value.',
|
description: 'Controlled markdown content value.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
readOnly: {
|
readOnly: {
|
||||||
description: 'Enables read-only mode.',
|
description: 'Enables read-only mode.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
disabled: {
|
disabled: {
|
||||||
description: 'Disables editing and applies disabled visuals.',
|
description: 'Disables editing and applies disabled visuals.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
themeClassName: {
|
themeClassName: {
|
||||||
description: 'Theme class applied to MDXEditor (for example `light-theme` or `dark-theme`).',
|
description: 'Theme class applied to MDXEditor (for example `light-theme` or `dark-theme`).',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
plugins: {
|
plugins: {
|
||||||
description: 'MDXEditor plugins array.',
|
description: 'MDXEditor plugins array.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'MDXEditorProps["plugins"]' } }
|
table: { type: { summary: 'MDXEditorProps["plugins"]' } },
|
||||||
},
|
},
|
||||||
contentEditableClassName: {
|
contentEditableClassName: {
|
||||||
description: 'CSS class used on the content editable area.',
|
description: 'CSS class used on the content editable area.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
className: {
|
className: {
|
||||||
description: 'Extra CSS classes for the outer wrapper.',
|
description: 'Extra CSS classes for the outer wrapper.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
editorWrapperClassName: {
|
editorWrapperClassName: {
|
||||||
description: 'Extra CSS classes for the editor shell element.',
|
description: 'Extra CSS classes for the editor shell element.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
editorWrapperStyle: {
|
editorWrapperStyle: {
|
||||||
description: 'Inline style object for the editor shell.',
|
description: 'Inline style object for the editor shell.',
|
||||||
control: 'object',
|
control: 'object',
|
||||||
table: { type: { summary: 'CSSProperties' } }
|
table: { type: { summary: 'CSSProperties' } },
|
||||||
},
|
},
|
||||||
editorClassName: {
|
editorClassName: {
|
||||||
description: 'Extra CSS classes for the MDXEditor instance.',
|
description: 'Extra CSS classes for the MDXEditor instance.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
error: {
|
error: {
|
||||||
description: 'Error message shown below the editor.',
|
description: 'Error message shown below the editor.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
onChange: {
|
onChange: {
|
||||||
description: 'Callback fired when markdown changes in editable mode.',
|
description: 'Callback fired when markdown changes in editable mode.',
|
||||||
action: 'changed',
|
action: 'changed',
|
||||||
table: { type: { summary: '(markdown: string) => void' } }
|
table: { type: { summary: '(markdown: string) => void' } },
|
||||||
},
|
},
|
||||||
editorRef: {
|
editorRef: {
|
||||||
description: 'Ref to MDXEditor methods.',
|
description: 'Ref to MDXEditor methods.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'Ref<MDXEditorMethods | null>' } }
|
table: { type: { summary: 'Ref<MDXEditorMethods | null>' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
label: 'Content',
|
label: 'Content',
|
||||||
markdown: sampleMarkdown,
|
markdown: sampleMarkdown,
|
||||||
plugins: basePlugins,
|
plugins: basePlugins,
|
||||||
themeClassName: ''
|
themeClassName: '',
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof MDXEditorField>;
|
} satisfies Meta<typeof MDXEditorField>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -128,34 +129,28 @@ export const Editable: Story = {
|
|||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const ReadOnly: Story = {
|
export const ReadOnly: Story = {
|
||||||
args: {
|
args: {
|
||||||
readOnly: true
|
readOnly: true,
|
||||||
},
|
},
|
||||||
render: (args) => (
|
render: (args) => (
|
||||||
<div className="w-full max-w-2xl">
|
<div className="w-full max-w-2xl">
|
||||||
<MDXEditorField
|
<MDXEditorField {...args} editorWrapperClassName="mt-2 overflow-hidden rounded-xl border" />
|
||||||
{...args}
|
|
||||||
editorWrapperClassName="mt-2 overflow-hidden rounded-xl border"
|
|
||||||
/>
|
|
||||||
</div>
|
</div>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|
||||||
export const DisabledWithError: Story = {
|
export const DisabledWithError: Story = {
|
||||||
args: {
|
args: {
|
||||||
disabled: true,
|
disabled: true,
|
||||||
error: 'Editor is currently disabled'
|
error: 'Editor is currently disabled',
|
||||||
},
|
},
|
||||||
render: (args) => (
|
render: (args) => (
|
||||||
<div className="w-full max-w-2xl">
|
<div className="w-full max-w-2xl">
|
||||||
<MDXEditorField
|
<MDXEditorField {...args} editorWrapperClassName="mt-2 overflow-hidden rounded-xl border" />
|
||||||
{...args}
|
|
||||||
editorWrapperClassName="mt-2 overflow-hidden rounded-xl border"
|
|
||||||
/>
|
|
||||||
</div>
|
</div>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -33,20 +33,28 @@ export function MDXEditorField({
|
|||||||
editorWrapperClassName = 'post-mdx-editor mt-2 overflow-hidden rounded-xl border',
|
editorWrapperClassName = 'post-mdx-editor mt-2 overflow-hidden rounded-xl border',
|
||||||
editorWrapperStyle,
|
editorWrapperStyle,
|
||||||
editorClassName = '',
|
editorClassName = '',
|
||||||
error
|
error,
|
||||||
}: Readonly<MDXEditorFieldProps>) {
|
}: Readonly<MDXEditorFieldProps>) {
|
||||||
const resolvedEditorClassName = `${themeClassName} ${editorClassName}`.trim();
|
const resolvedEditorClassName = `${themeClassName} ${editorClassName}`.trim();
|
||||||
const editorModeKey = disabled || readOnly ? 'read-only' : 'editable';
|
const editorModeKey = disabled || readOnly ? 'read-only' : 'editable';
|
||||||
const resolvedEditorWrapperClassName = `${editorWrapperClassName} ${disabled ? 'post-mdx-editor--disabled' : 'post-mdx-editor--enabled'}`.trim();
|
const resolvedEditorWrapperClassName =
|
||||||
|
`${editorWrapperClassName} ${disabled ? 'post-mdx-editor--disabled' : 'post-mdx-editor--enabled'}`.trim();
|
||||||
const resolvedEditorWrapperStyle: CSSProperties = {
|
const resolvedEditorWrapperStyle: CSSProperties = {
|
||||||
backgroundColor: disabled ? 'var(--field-disabled-bg)' : 'var(--field-bg)',
|
backgroundColor: disabled ? 'var(--field-disabled-bg)' : 'var(--field-bg)',
|
||||||
borderColor: disabled ? 'var(--field-disabled-border)' : 'var(--field-border)',
|
borderColor: disabled ? 'var(--field-disabled-border)' : 'var(--field-border)',
|
||||||
...editorWrapperStyle
|
...editorWrapperStyle,
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className={className}>
|
<div className={className}>
|
||||||
{label ? <Label variant="body" className={`font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'}`}>{label}</Label> : null}
|
{label ? (
|
||||||
|
<Label
|
||||||
|
variant="body"
|
||||||
|
className={`font-medium ${disabled ? 'ui-label-disabled' : 'ui-label'}`}
|
||||||
|
>
|
||||||
|
{label}
|
||||||
|
</Label>
|
||||||
|
) : null}
|
||||||
<div className={resolvedEditorWrapperClassName} style={resolvedEditorWrapperStyle}>
|
<div className={resolvedEditorWrapperClassName} style={resolvedEditorWrapperStyle}>
|
||||||
<MDXEditor
|
<MDXEditor
|
||||||
key={editorModeKey}
|
key={editorModeKey}
|
||||||
@@ -59,7 +67,11 @@ export function MDXEditorField({
|
|||||||
plugins={plugins}
|
plugins={plugins}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
{error ? <Label variant="error" className="mt-2 ui-error">{error}</Label> : null}
|
{error ? (
|
||||||
|
<Label variant="error" className="mt-2 ui-error">
|
||||||
|
{error}
|
||||||
|
</Label>
|
||||||
|
) : null}
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,43 +10,44 @@ const meta = {
|
|||||||
layout: 'padded',
|
layout: 'padded',
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Sidebar navigation link with active state styling and collapsed/expanded rendering mode.'
|
component:
|
||||||
}
|
'Sidebar navigation link with active state styling and collapsed/expanded rendering mode.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
to: {
|
to: {
|
||||||
description: 'Destination route path.',
|
description: 'Destination route path.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
label: {
|
label: {
|
||||||
description: 'Navigation item label.',
|
description: 'Navigation item label.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
icon: {
|
icon: {
|
||||||
description: 'Icon component rendered before the label.',
|
description: 'Icon component rendered before the label.',
|
||||||
control: false,
|
control: false,
|
||||||
table: { type: { summary: 'ComponentType<SVGProps<SVGSVGElement>>' } }
|
table: { type: { summary: 'ComponentType<SVGProps<SVGSVGElement>>' } },
|
||||||
},
|
},
|
||||||
collapsed: {
|
collapsed: {
|
||||||
description: 'Collapsed state. When true, desktop view shows icon-only rail style.',
|
description: 'Collapsed state. When true, desktop view shows icon-only rail style.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
onClick: {
|
onClick: {
|
||||||
description: 'Optional click callback (for example to close mobile drawer).',
|
description: 'Optional click callback (for example to close mobile drawer).',
|
||||||
action: 'clicked',
|
action: 'clicked',
|
||||||
table: { type: { summary: '() => void' } }
|
table: { type: { summary: '() => void' } },
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
to: '/',
|
to: '/',
|
||||||
label: 'Dashboard',
|
label: 'Dashboard',
|
||||||
icon: HomeIcon,
|
icon: HomeIcon,
|
||||||
collapsed: false
|
collapsed: false,
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof SidebarNavItem>;
|
} satisfies Meta<typeof SidebarNavItem>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -57,14 +58,19 @@ export const Expanded: Story = {
|
|||||||
<nav className="flex w-56 flex-col gap-1">
|
<nav className="flex w-56 flex-col gap-1">
|
||||||
<SidebarNavItem {...args} />
|
<SidebarNavItem {...args} />
|
||||||
<SidebarNavItem to="/users" label="Users" icon={UsersIcon} collapsed={args.collapsed} />
|
<SidebarNavItem to="/users" label="Users" icon={UsersIcon} collapsed={args.collapsed} />
|
||||||
<SidebarNavItem to="/profile" label="Profile" icon={UserCircleIcon} collapsed={args.collapsed} />
|
<SidebarNavItem
|
||||||
|
to="/profile"
|
||||||
|
label="Profile"
|
||||||
|
icon={UserCircleIcon}
|
||||||
|
collapsed={args.collapsed}
|
||||||
|
/>
|
||||||
</nav>
|
</nav>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Collapsed: Story = {
|
export const Collapsed: Story = {
|
||||||
args: {
|
args: {
|
||||||
collapsed: true
|
collapsed: true,
|
||||||
},
|
},
|
||||||
render: (args) => (
|
render: (args) => (
|
||||||
<nav className="flex w-14 flex-col gap-1">
|
<nav className="flex w-14 flex-col gap-1">
|
||||||
@@ -72,5 +78,5 @@ export const Collapsed: Story = {
|
|||||||
<SidebarNavItem to="/users" label="Users" icon={UsersIcon} collapsed />
|
<SidebarNavItem to="/users" label="Users" icon={UsersIcon} collapsed />
|
||||||
<SidebarNavItem to="/profile" label="Profile" icon={UserCircleIcon} collapsed />
|
<SidebarNavItem to="/profile" label="Profile" icon={UserCircleIcon} collapsed />
|
||||||
</nav>
|
</nav>
|
||||||
)
|
),
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -11,7 +11,13 @@ type SidebarNavItemProps = {
|
|||||||
onClick?: () => void;
|
onClick?: () => void;
|
||||||
};
|
};
|
||||||
|
|
||||||
export function SidebarNavItem({ to, label, icon: Icon, collapsed, onClick }: Readonly<SidebarNavItemProps>) {
|
export function SidebarNavItem({
|
||||||
|
to,
|
||||||
|
label,
|
||||||
|
icon: Icon,
|
||||||
|
collapsed,
|
||||||
|
onClick,
|
||||||
|
}: Readonly<SidebarNavItemProps>) {
|
||||||
const layoutClass = collapsed
|
const layoutClass = collapsed
|
||||||
? 'mx-auto w-8 justify-center px-0'
|
? 'mx-auto w-8 justify-center px-0'
|
||||||
: 'px-2 lg:w-full lg:justify-start';
|
: 'px-2 lg:w-full lg:justify-start';
|
||||||
@@ -20,14 +26,18 @@ export function SidebarNavItem({ to, label, icon: Icon, collapsed, onClick }: Re
|
|||||||
<NavLink
|
<NavLink
|
||||||
to={to}
|
to={to}
|
||||||
onClick={onClick}
|
onClick={onClick}
|
||||||
className={({ isActive }) => (
|
className={({ isActive }) =>
|
||||||
`inline-flex h-8 items-center rounded-lg text-sm font-medium transition ${layoutClass} ${
|
`inline-flex h-8 items-center rounded-lg text-sm font-medium transition ${layoutClass} ${
|
||||||
isActive ? 'bg-accent-500 text-white' : 'ui-body-secondary hover:bg-zinc-500/15'
|
isActive ? 'bg-accent-500 text-white' : 'ui-body-secondary hover:bg-zinc-500/15'
|
||||||
}`
|
}`
|
||||||
)}
|
}
|
||||||
>
|
>
|
||||||
<Icon className="h-4 w-4 shrink-0" />
|
<Icon className="h-4 w-4 shrink-0" />
|
||||||
{!collapsed ? <span className="ml-2 truncate leading-none">{label}</span> : <span className="ml-2 lg:hidden">{label}</span>}
|
{!collapsed ? (
|
||||||
|
<span className="ml-2 truncate leading-none">{label}</span>
|
||||||
|
) : (
|
||||||
|
<span className="ml-2 lg:hidden">{label}</span>
|
||||||
|
)}
|
||||||
</NavLink>
|
</NavLink>
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ const rows: UserRow[] = [
|
|||||||
{ id: '5', name: 'Andrea Pini', role: 'EDITOR', status: 'Pending', posts: 9 },
|
{ id: '5', name: 'Andrea Pini', role: 'EDITOR', status: 'Pending', posts: 9 },
|
||||||
{ id: '6', name: 'Sofia Denti', role: 'AUTHOR', status: 'Active', posts: 7 },
|
{ id: '6', name: 'Sofia Denti', role: 'AUTHOR', status: 'Active', posts: 7 },
|
||||||
{ id: '7', name: 'Marco Serra', role: 'AUTHOR', status: 'Active', posts: 18 },
|
{ id: '7', name: 'Marco Serra', role: 'AUTHOR', status: 'Active', posts: 18 },
|
||||||
{ id: '8', name: 'Elena Neri', role: 'EDITOR', status: 'Active', posts: 31 }
|
{ id: '8', name: 'Elena Neri', role: 'EDITOR', status: 'Active', posts: 31 },
|
||||||
];
|
];
|
||||||
|
|
||||||
const headers: TableHeader<UserRow>[] = [
|
const headers: TableHeader<UserRow>[] = [
|
||||||
@@ -30,14 +30,14 @@ const headers: TableHeader<UserRow>[] = [
|
|||||||
value: (row) => row.name,
|
value: (row) => row.name,
|
||||||
sortable: true,
|
sortable: true,
|
||||||
sortField: 'name',
|
sortField: 'name',
|
||||||
cellClassName: 'table-cell-primary'
|
cellClassName: 'table-cell-primary',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'role',
|
id: 'role',
|
||||||
label: 'Role',
|
label: 'Role',
|
||||||
value: (row) => row.role,
|
value: (row) => row.role,
|
||||||
sortable: true,
|
sortable: true,
|
||||||
sortField: 'role'
|
sortField: 'role',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'status',
|
id: 'status',
|
||||||
@@ -46,15 +46,15 @@ const headers: TableHeader<UserRow>[] = [
|
|||||||
<Chip variant="outlined" tone={row.status === 'Active' ? 'indigo-700' : 'cyan-700'}>
|
<Chip variant="outlined" tone={row.status === 'Active' ? 'indigo-700' : 'cyan-700'}>
|
||||||
{row.status}
|
{row.status}
|
||||||
</Chip>
|
</Chip>
|
||||||
)
|
),
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'posts',
|
id: 'posts',
|
||||||
label: 'Posts',
|
label: 'Posts',
|
||||||
value: (row) => row.posts,
|
value: (row) => row.posts,
|
||||||
sortable: true,
|
sortable: true,
|
||||||
sortField: 'posts'
|
sortField: 'posts',
|
||||||
}
|
},
|
||||||
];
|
];
|
||||||
|
|
||||||
type UsersTableProps = {
|
type UsersTableProps = {
|
||||||
@@ -117,49 +117,50 @@ const meta = {
|
|||||||
parameters: {
|
parameters: {
|
||||||
docs: {
|
docs: {
|
||||||
description: {
|
description: {
|
||||||
component: 'Generic data table with loading/empty states, optional sorting controls, and optional pagination footer.'
|
component:
|
||||||
}
|
'Generic data table with loading/empty states, optional sorting controls, and optional pagination footer.',
|
||||||
}
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
argTypes: {
|
argTypes: {
|
||||||
data: {
|
data: {
|
||||||
description: 'Rows rendered in the table body.',
|
description: 'Rows rendered in the table body.',
|
||||||
control: 'object',
|
control: 'object',
|
||||||
table: { type: { summary: 'UserRow[]' } }
|
table: { type: { summary: 'UserRow[]' } },
|
||||||
},
|
},
|
||||||
isLoading: {
|
isLoading: {
|
||||||
description: 'When true, shows the loading indicator row.',
|
description: 'When true, shows the loading indicator row.',
|
||||||
control: 'boolean',
|
control: 'boolean',
|
||||||
table: { type: { summary: 'boolean' } }
|
table: { type: { summary: 'boolean' } },
|
||||||
},
|
},
|
||||||
emptyMessage: {
|
emptyMessage: {
|
||||||
description: 'Message shown when `data` is empty and `isLoading` is false.',
|
description: 'Message shown when `data` is empty and `isLoading` is false.',
|
||||||
control: 'text',
|
control: 'text',
|
||||||
table: { type: { summary: 'string' } }
|
table: { type: { summary: 'string' } },
|
||||||
},
|
},
|
||||||
sorting: {
|
sorting: {
|
||||||
description: "Current sort state object. Use `null` for no active sorting.",
|
description: 'Current sort state object. Use `null` for no active sorting.',
|
||||||
control: 'object',
|
control: 'object',
|
||||||
table: { type: { summary: "{ field: string; direction: 'asc' | 'desc' } | null" } }
|
table: { type: { summary: "{ field: string; direction: 'asc' | 'desc' } | null" } },
|
||||||
},
|
},
|
||||||
onSortChange: {
|
onSortChange: {
|
||||||
description: 'Callback fired when a sortable header is clicked.',
|
description: 'Callback fired when a sortable header is clicked.',
|
||||||
action: 'sort changed',
|
action: 'sort changed',
|
||||||
table: { type: { summary: '(field: string) => void' } }
|
table: { type: { summary: '(field: string) => void' } },
|
||||||
},
|
},
|
||||||
pagination: {
|
pagination: {
|
||||||
description: 'Pagination config object. When omitted, pagination footer is hidden.',
|
description: 'Pagination config object. When omitted, pagination footer is hidden.',
|
||||||
control: 'object',
|
control: 'object',
|
||||||
table: {
|
table: {
|
||||||
type: {
|
type: {
|
||||||
summary: '{ page; pageSize; total; totalPages; onPageChange; onPageSizeChange? }'
|
summary: '{ page; pageSize; total; totalPages; onPageChange; onPageSizeChange? }',
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
args: {
|
args: {
|
||||||
data: rows
|
data: rows,
|
||||||
}
|
},
|
||||||
} satisfies Meta<typeof UsersTable>;
|
} satisfies Meta<typeof UsersTable>;
|
||||||
|
|
||||||
export default meta;
|
export default meta;
|
||||||
@@ -169,22 +170,22 @@ export const WithRows: Story = {};
|
|||||||
|
|
||||||
export const Loading: Story = {
|
export const Loading: Story = {
|
||||||
args: {
|
args: {
|
||||||
isLoading: true
|
isLoading: true,
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const Empty: Story = {
|
export const Empty: Story = {
|
||||||
args: {
|
args: {
|
||||||
data: [],
|
data: [],
|
||||||
emptyMessage: 'No users found'
|
emptyMessage: 'No users found',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
export const InteractiveSortingAndPagination: Story = {
|
export const InteractiveSortingAndPagination: Story = {
|
||||||
render: () => {
|
render: () => {
|
||||||
const [sorting, setSorting] = useState<SortState | null>({
|
const [sorting, setSorting] = useState<SortState | null>({
|
||||||
field: 'name',
|
field: 'name',
|
||||||
direction: 'asc'
|
direction: 'asc',
|
||||||
});
|
});
|
||||||
const [page, setPage] = useState(1);
|
const [page, setPage] = useState(1);
|
||||||
const [pageSize, setPageSize] = useState(5);
|
const [pageSize, setPageSize] = useState(5);
|
||||||
@@ -220,9 +221,9 @@ export const InteractiveSortingAndPagination: Story = {
|
|||||||
onPageSizeChange: (next) => {
|
onPageSizeChange: (next) => {
|
||||||
setPage(1);
|
setPage(1);
|
||||||
setPageSize(next);
|
setPageSize(next);
|
||||||
}
|
},
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
);
|
);
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -1,5 +1,11 @@
|
|||||||
import type { ReactNode } from 'react';
|
import type { ReactNode } from 'react';
|
||||||
import { ArrowPathIcon, ChevronDownIcon, ChevronLeftIcon, ChevronRightIcon, ChevronUpIcon } from '@heroicons/react/24/solid';
|
import {
|
||||||
|
ArrowPathIcon,
|
||||||
|
ChevronDownIcon,
|
||||||
|
ChevronLeftIcon,
|
||||||
|
ChevronRightIcon,
|
||||||
|
ChevronUpIcon,
|
||||||
|
} from '@heroicons/react/24/solid';
|
||||||
import { ArrowsUpDownIcon } from '@heroicons/react/24/outline';
|
import { ArrowsUpDownIcon } from '@heroicons/react/24/outline';
|
||||||
import { Button } from './Button';
|
import { Button } from './Button';
|
||||||
import { Dropdown } from './Dropdown';
|
import { Dropdown } from './Dropdown';
|
||||||
@@ -46,7 +52,7 @@ export function Table<T>({
|
|||||||
className = '',
|
className = '',
|
||||||
sorting = null,
|
sorting = null,
|
||||||
onSortChange,
|
onSortChange,
|
||||||
pagination
|
pagination,
|
||||||
}: Readonly<TableProps<T>>) {
|
}: Readonly<TableProps<T>>) {
|
||||||
const canGoPrev = pagination != null && pagination.page > 1;
|
const canGoPrev = pagination != null && pagination.page > 1;
|
||||||
const canGoNext = pagination != null && pagination.page < pagination.totalPages;
|
const canGoNext = pagination != null && pagination.page < pagination.totalPages;
|
||||||
@@ -58,15 +64,19 @@ export function Table<T>({
|
|||||||
<thead className="table-head">
|
<thead className="table-head">
|
||||||
<tr>
|
<tr>
|
||||||
{headers.map((header) => {
|
{headers.map((header) => {
|
||||||
const canSort = header.sortable === true
|
const canSort =
|
||||||
&& typeof onSortChange === 'function'
|
header.sortable === true &&
|
||||||
&& typeof header.sortField === 'string'
|
typeof onSortChange === 'function' &&
|
||||||
&& header.sortField.length > 0;
|
typeof header.sortField === 'string' &&
|
||||||
|
header.sortField.length > 0;
|
||||||
const isActiveSort = canSort && sorting?.field === header.sortField;
|
const isActiveSort = canSort && sorting?.field === header.sortField;
|
||||||
const sortDirection = isActiveSort ? sorting?.direction : null;
|
const sortDirection = isActiveSort ? sorting?.direction : null;
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<th key={header.id} className={`table-head-cell ${header.headerClassName ?? ''}`.trim()}>
|
<th
|
||||||
|
key={header.id}
|
||||||
|
className={`table-head-cell ${header.headerClassName ?? ''}`.trim()}
|
||||||
|
>
|
||||||
{canSort ? (
|
{canSort ? (
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
@@ -75,16 +85,16 @@ export function Table<T>({
|
|||||||
aria-label={`Sort by ${header.label}`}
|
aria-label={`Sort by ${header.label}`}
|
||||||
>
|
>
|
||||||
<span>{header.label}</span>
|
<span>{header.label}</span>
|
||||||
<span className="table-sort-icon" aria-hidden="true" data-sort-state={sortDirection ?? 'none'}>
|
<span
|
||||||
{sortDirection === 'asc' ? (
|
className="table-sort-icon"
|
||||||
<ChevronUpIcon className="h-4 w-4" />
|
aria-hidden="true"
|
||||||
) : null}
|
data-sort-state={sortDirection ?? 'none'}
|
||||||
|
>
|
||||||
|
{sortDirection === 'asc' ? <ChevronUpIcon className="h-4 w-4" /> : null}
|
||||||
{sortDirection === 'desc' ? (
|
{sortDirection === 'desc' ? (
|
||||||
<ChevronDownIcon className="h-4 w-4" />
|
<ChevronDownIcon className="h-4 w-4" />
|
||||||
) : null}
|
) : null}
|
||||||
{sortDirection == null ? (
|
{sortDirection == null ? <ArrowsUpDownIcon className="h-4 w-4" /> : null}
|
||||||
<ArrowsUpDownIcon className="h-4 w-4" />
|
|
||||||
) : null}
|
|
||||||
</span>
|
</span>
|
||||||
</button>
|
</button>
|
||||||
) : (
|
) : (
|
||||||
@@ -99,7 +109,11 @@ export function Table<T>({
|
|||||||
{isLoading ? (
|
{isLoading ? (
|
||||||
<tr className="table-body-row">
|
<tr className="table-body-row">
|
||||||
<td colSpan={headers.length} className="px-4 py-6 text-center">
|
<td colSpan={headers.length} className="px-4 py-6 text-center">
|
||||||
<Label as="span" variant="body2" className="inline-flex items-center justify-center ui-loading">
|
<Label
|
||||||
|
as="span"
|
||||||
|
variant="body2"
|
||||||
|
className="inline-flex items-center justify-center ui-loading"
|
||||||
|
>
|
||||||
<ArrowPathIcon className="h-5 w-5 animate-spin" aria-hidden="true" />
|
<ArrowPathIcon className="h-5 w-5 animate-spin" aria-hidden="true" />
|
||||||
</Label>
|
</Label>
|
||||||
</td>
|
</td>
|
||||||
@@ -114,28 +128,31 @@ export function Table<T>({
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
) : null}
|
) : null}
|
||||||
{!isLoading && data.map((row, index) => (
|
{!isLoading &&
|
||||||
<tr key={rowKey(row, index)} className="table-body-row">
|
data.map((row, index) => (
|
||||||
{headers.map((header) => {
|
<tr key={rowKey(row, index)} className="table-body-row">
|
||||||
const content = typeof header.value === 'function'
|
{headers.map((header) => {
|
||||||
? (header.value as (item: T) => ReactNode)(row)
|
const content =
|
||||||
: header.value;
|
typeof header.value === 'function'
|
||||||
return (
|
? (header.value as (item: T) => ReactNode)(row)
|
||||||
<td key={`${header.id}-${index}`} className={`table-cell-secondary ${header.cellClassName ?? ''}`.trim()}>
|
: header.value;
|
||||||
{content}
|
return (
|
||||||
</td>
|
<td
|
||||||
);
|
key={`${header.id}-${index}`}
|
||||||
})}
|
className={`table-cell-secondary ${header.cellClassName ?? ''}`.trim()}
|
||||||
</tr>
|
>
|
||||||
))}
|
{content}
|
||||||
|
</td>
|
||||||
|
);
|
||||||
|
})}
|
||||||
|
</tr>
|
||||||
|
))}
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
</div>
|
</div>
|
||||||
{pagination ? (
|
{pagination ? (
|
||||||
<div className="flex flex-col gap-3 border-t border-zinc-500/20 px-4 py-3 sm:flex-row sm:items-center sm:justify-between">
|
<div className="flex flex-col gap-3 border-t border-zinc-500/20 px-4 py-3 sm:flex-row sm:items-center sm:justify-between">
|
||||||
<Label variant="body2">
|
<Label variant="body2">{pagination.total} results</Label>
|
||||||
{pagination.total} results
|
|
||||||
</Label>
|
|
||||||
<div className="flex flex-wrap items-center gap-2">
|
<div className="flex flex-wrap items-center gap-2">
|
||||||
{pagination.onPageSizeChange ? (
|
{pagination.onPageSizeChange ? (
|
||||||
<Dropdown
|
<Dropdown
|
||||||
@@ -143,7 +160,7 @@ export function Table<T>({
|
|||||||
value={String(pagination.pageSize)}
|
value={String(pagination.pageSize)}
|
||||||
choices={[5, 10, 20, 50, 100].map((size) => ({
|
choices={[5, 10, 20, 50, 100].map((size) => ({
|
||||||
id: String(size),
|
id: String(size),
|
||||||
label: String(size)
|
label: String(size),
|
||||||
}))}
|
}))}
|
||||||
size="sm"
|
size="sm"
|
||||||
layout="inline"
|
layout="inline"
|
||||||
|
|||||||
@@ -91,4 +91,3 @@
|
|||||||
--mdx-codeblock-bracket: rgba(125, 111, 152, 0.32);
|
--mdx-codeblock-bracket: rgba(125, 111, 152, 0.32);
|
||||||
--shadow-glow: 0 0 0 1px rgba(212, 212, 216, 0.9), 0 18px 36px rgba(15, 23, 42, 0.08);
|
--shadow-glow: 0 0 0 1px rgba(212, 212, 216, 0.9), 0 18px 36px rgba(15, 23, 42, 0.08);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -7,15 +7,15 @@ module.exports = {
|
|||||||
300: '#a89bbf',
|
300: '#a89bbf',
|
||||||
400: '#9587ad',
|
400: '#9587ad',
|
||||||
500: '#7d6f98',
|
500: '#7d6f98',
|
||||||
600: '#6a5d84'
|
600: '#6a5d84',
|
||||||
}
|
},
|
||||||
},
|
},
|
||||||
fontFamily: {
|
fontFamily: {
|
||||||
sans: ['Inter', 'ui-sans-serif', 'system-ui', 'sans-serif']
|
sans: ['Inter', 'ui-sans-serif', 'system-ui', 'sans-serif'],
|
||||||
},
|
},
|
||||||
boxShadow: {
|
boxShadow: {
|
||||||
glow: '0 0 0 1px rgba(63,63,70,0.65), 0 18px 44px rgba(0,0,0,0.45)'
|
glow: '0 0 0 1px rgba(63,63,70,0.65), 0 18px 44px rgba(0,0,0,0.45)',
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -3,14 +3,12 @@ const webUiPreset = require('./tailwind-preset.cjs');
|
|||||||
/** @type {import('tailwindcss').Config} */
|
/** @type {import('tailwindcss').Config} */
|
||||||
module.exports = {
|
module.exports = {
|
||||||
presets: [webUiPreset],
|
presets: [webUiPreset],
|
||||||
content: [
|
content: ['./src/**/*.{ts,tsx,js,jsx}'],
|
||||||
'./src/**/*.{ts,tsx,js,jsx}'
|
|
||||||
],
|
|
||||||
corePlugins: {
|
corePlugins: {
|
||||||
preflight: false
|
preflight: false,
|
||||||
},
|
},
|
||||||
theme: {
|
theme: {
|
||||||
extend: {}
|
extend: {},
|
||||||
},
|
},
|
||||||
plugins: []
|
plugins: [],
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -3,12 +3,9 @@ const webUiPreset = require('./tailwind-preset.cjs');
|
|||||||
/** @type {import('tailwindcss').Config} */
|
/** @type {import('tailwindcss').Config} */
|
||||||
module.exports = {
|
module.exports = {
|
||||||
presets: [webUiPreset],
|
presets: [webUiPreset],
|
||||||
content: [
|
content: ['./src/**/*.{ts,tsx,js,jsx,mdx}', './.storybook/**/*.{ts,tsx,js,jsx,mdx}'],
|
||||||
'./src/**/*.{ts,tsx,js,jsx,mdx}',
|
|
||||||
'./.storybook/**/*.{ts,tsx,js,jsx,mdx}'
|
|
||||||
],
|
|
||||||
theme: {
|
theme: {
|
||||||
extend: {}
|
extend: {},
|
||||||
},
|
},
|
||||||
plugins: []
|
plugins: [],
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -8,20 +8,14 @@ export default defineConfig({
|
|||||||
lib: {
|
lib: {
|
||||||
entry: {
|
entry: {
|
||||||
index: resolve(__dirname, 'src/index.ts'),
|
index: resolve(__dirname, 'src/index.ts'),
|
||||||
'components/MDXEditorField': resolve(__dirname, 'src/components/MDXEditorField.tsx')
|
'components/MDXEditorField': resolve(__dirname, 'src/components/MDXEditorField.tsx'),
|
||||||
},
|
},
|
||||||
name: 'PanicWebUi',
|
name: 'PanicWebUi',
|
||||||
formats: ['es'],
|
formats: ['es'],
|
||||||
fileName: (_format, entryName) => `${entryName}.js`
|
fileName: (_format, entryName) => `${entryName}.js`,
|
||||||
},
|
},
|
||||||
rollupOptions: {
|
rollupOptions: {
|
||||||
external: [
|
external: ['react', 'react-dom', 'react-router-dom', '@heroicons/react', '@mdxeditor/editor'],
|
||||||
'react',
|
},
|
||||||
'react-dom',
|
},
|
||||||
'react-router-dom',
|
|
||||||
'@heroicons/react',
|
|
||||||
'@mdxeditor/editor'
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
});
|
||||||
|
|||||||
Reference in New Issue
Block a user