Files
supabase/apps/studio/components/interfaces/Docs/Param.tsx
T
Ivan VasilovandJoshen Lim 05a542ccea chore: Migrate all feather icons to lucide icons (#29038)
* Add lucide-react to docs (to make the autocomplete work).

* Migrate the docs app icons.

* Migrate the ui-patterns.

* Remove the old icons from ui package.

* Migrate the www app from react-feather icons.

* Migrate all of studio icons.

* Migrate the only component in design-system.

* Fix an old import in ui package. Revert an import in docs app.

* Fix some pages in www.

* Remove unneeded files used in generation of icons.

* Fix a prettier error.

* Fix more issues in www.

* Fix an issue in Log Date picker.

* Replace all string sizes with number sizes because the icons grew in some cases.

* Fix more imports in security page.

* Fix an extra import.

* Remove the size prop from all icons if they're in a button and they match the button size.

* Minor fixes for docs and www.

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2024-09-04 19:46:21 +08:00

108 lines
3.1 KiB
TypeScript

import { noop } from 'lodash'
import { Badge } from 'ui'
import Description from 'components/interfaces/Docs/Description'
import { Code, Database } from 'lucide-react'
function getColumnType(type: string, format: string) {
// json and jsonb both have type=undefined, so check format instead
if (type === undefined && (format === 'jsonb' || format === 'json')) return 'json'
switch (type) {
case 'string':
return 'string'
case 'integer':
return 'number'
case 'json':
return 'json'
case 'number':
return 'number'
case 'boolean':
return 'boolean'
default:
return ''
}
}
interface ParamProps {
name: string
type: string
format: string
required: boolean
description: boolean
metadata?: any
onDesciptionUpdated?: () => void
}
const Param = ({
name,
type,
format,
required,
description,
metadata = {},
onDesciptionUpdated = noop,
}: ParamProps) => {
return (
<>
<div className="mb-4 flex items-center justify-between ">
<div className="flex gap-2 items-center">
<div className="flex items-center gap-2">
<label className="font-mono text-xs uppercase text-foreground-lighter min-w-[55px]">
Column
</label>
<div className="flex items-center gap-4">
<span className="text-md text-foreground pb-0.5">{name}</span>
</div>
</div>
</div>
<Badge variant={required ? 'warning' : 'default'}>
{required ? 'Required' : 'Optional'}
</Badge>
</div>
{format && (
<div className="grid gap-2 mt-6">
<div className="mb-4 flex items-center gap-2">
<label className="font-mono text-xs uppercase text-foreground-lighter min-w-[55px]">
Type
</label>
<div>
<span className="flex grow-0 bg-slate-300 px-2 py-0.5 rounded-md text-foreground-light">
<span className="flex items-center gap-2 text-sm">
<Code size="14" />
<span>{getColumnType(type, format)}</span>
</span>
</span>
</div>
</div>
<div className="mb-4 flex items-center gap-2">
<label className="font-mono text-xs uppercase text-foreground-lighter min-w-[55px]">
Format
</label>
<div>
<span className="flex grow-0 bg-slate-300 px-2 py-0.5 rounded-md text-foreground-light">
<span className="flex items-center gap-2 text-sm">
<Database size="14" />
<span>{format}</span>
</span>
</span>
</div>
</div>
</div>
)}
{description !== false && (
<div className="grid gap-2 mt-2">
<label className="font-mono text-xs uppercase text-foreground-lighter">Description</label>
<Description
content={description?.toString()}
metadata={metadata}
onChange={onDesciptionUpdated}
/>
</div>
)}
</>
)
}
export default Param