Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add transparent variant to section footer with pagination #300

Merged
merged 2 commits into from
Nov 22, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions src/components/section/SectionFooter/SectionFooterArea.stories.mdx

This file was deleted.

43 changes: 43 additions & 0 deletions src/components/section/SectionFooter/SectionFooterArea.stories.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { Meta, StoryObj } from '@storybook/react'
import {
Controls,
Primary,
Stories,
Subheading,
Title,
Description,
} from '@storybook/addon-docs'
import { Theme } from '../../../../.storybook/components'
import { SectionFooterArea } from '../index'
import { SectionFooterVariant } from './types'

const meta = {
component: SectionFooterArea,
parameters: {
docs: {
page: () => (
<>
<Title />
<Description />
<Primary />
<Subheading>Props</Subheading>
<Controls />
<Theme component="section" items={['footerArea']} />
<Stories />
</>
),
},
},
} satisfies Meta<typeof SectionFooterArea>

export default meta

type Story = StoryObj<typeof meta>

export const Default: Story = {}

export const VariantTransparent: Story = {
args: {
variant: SectionFooterVariant.Transparent,
},
}
18 changes: 16 additions & 2 deletions src/components/section/SectionFooter/SectionFooterArea.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,31 @@ import classNames from 'classnames'
import { ReactNode } from 'react'
import { useTheme } from '../../../framework'
import { ClassNameProps } from '../../types'
import { SectionFooterVariant } from './types'

export type SectionFooterAreaProps = ClassNameProps & { children?: ReactNode }
export type SectionFooterAreaProps = ClassNameProps & {
children?: ReactNode
variant?: SectionFooterVariant
}

/**
* The section footer is a component that should be placed at the bottom of a [SectionContainer](../?path=/docs/components-section-sectioncontainer--docs). It is used as a container for the section footer where, for example, the pagination can be placed.
*/
export function SectionFooterArea({
className,
children,
variant = SectionFooterVariant.Solid,
}: SectionFooterAreaProps) {
const { section } = useTheme()

return (
<div className={classNames(className, section.footerArea.base)}>
<div
className={classNames(
section.footerArea.base,
section.footerArea[variant],
className,
)}
>
{children}
</div>
)
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import { Meta, StoryObj } from '@storybook/react'
import {
Controls,
Primary,
Stories,
Subheading,
Title,
Description,
} from '@storybook/addon-docs'
import { IndexType } from '@aboutbits/pagination'
import { useState } from 'react'
import { SectionFooterVariant } from './types'
import {
SectionFooterWithPaginationInMemory,
SectionFooterWithPaginationInMemoryProps,
} from './SectionFooterWithPaginationInMemory'

const Template = (args: SectionFooterWithPaginationInMemoryProps) => {
const [page, setPage] = useState(args.page)
return (
<SectionFooterWithPaginationInMemory
{...args}
page={page}
onChangePage={setPage}
/>
)
}

const meta = {
component: SectionFooterWithPaginationInMemory,
parameters: {
docs: {
page: () => (
<>
<Title />
<Description />
<Primary />
<Subheading>Props</Subheading>
<Controls />
<Stories />
</>
),
},
},
render: (args) => <Template {...args} />,
} satisfies Meta<typeof SectionFooterWithPaginationInMemory>

export default meta

type Story = StoryObj<typeof meta>

export const Default: Story = {
args: {
page: 0,
size: 10,
total: 60,
config: { indexType: IndexType.ZERO_BASED },
},
}

export const VariantTransparent: Story = {
args: {
...Default.args,
variant: SectionFooterVariant.Transparent,
},
}
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
import { ReactElement } from 'react'
import { PaginationInMemory, PaginationInMemoryProps } from '../../pagination'
import { SectionFooterArea } from '../index'
import { SectionFooterArea, SectionFooterAreaProps } from '../index'

export type SectionFooterWithPaginationInMemoryProps = Pick<
SectionFooterAreaProps,
'variant'
> &
PaginationInMemoryProps

/**
* This component can conveniently be used to add a pagination with a section footer. This component leverages on [SectionFooter](/docs/components-section-sectionfooter--section-footer--docs) and [PaginationInMemory](/docs/components-pagination-paginationinmemory--docs).
*/
export function SectionFooterWithPaginationInMemory({
page,
size,
total,
onChangePage,
config,
className,
}: PaginationInMemoryProps): ReactElement | null {
variant,
}: SectionFooterWithPaginationInMemoryProps) {
if (total <= size) {
return null
}

return (
<SectionFooterArea>
<SectionFooterArea variant={variant}>
<PaginationInMemory
page={page}
size={size}
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import { Meta, StoryObj } from '@storybook/react'
import {
Controls,
Primary,
Stories,
Subheading,
Title,
Description,
} from '@storybook/addon-docs'
import { IndexType } from '@aboutbits/pagination'
import { SectionFooterWithPaginationRouter } from './SectionFooterWithPaginationRouter'
import { SectionFooterVariant } from './types'

const meta = {
component: SectionFooterWithPaginationRouter,
parameters: {
docs: {
page: () => (
<>
<Title />
<Description />
<Primary />
<Subheading>Props</Subheading>
<Controls />
<Stories />
</>
),
},
},
render: (args) => {
const currentParams = new URLSearchParams(window.parent.location.search)
const pageParam = currentParams.get('page')
const currentPage = pageParam ? parseInt(pageParam) : 0
return <SectionFooterWithPaginationRouter {...args} page={currentPage} />
},
} satisfies Meta<typeof SectionFooterWithPaginationRouter>

export default meta

type Story = StoryObj<typeof meta>

export const Default: Story = {
args: {
page: 0,
size: 10,
total: 60,
config: { indexType: IndexType.ZERO_BASED },
},
}

export const VariantTransparent: Story = {
args: {
...Default.args,
variant: SectionFooterVariant.Transparent,
},
}
Original file line number Diff line number Diff line change
@@ -1,21 +1,30 @@
import { ReactElement } from 'react'
import { PaginationRouter, PaginationRouterProps } from '../../pagination'
import { SectionFooterArea } from './SectionFooterArea'
import { SectionFooterArea, SectionFooterAreaProps } from './SectionFooterArea'

export type SectionFooterWithPaginationRouterProps = Pick<
SectionFooterAreaProps,
'variant'
> &
PaginationRouterProps

/**
* This component can conveniently be used to add a pagination with a section footer. This component leverages on [SectionFooter](/docs/components-section-sectionfooter--section-footer--docs) and [PaginationRouter](/docs/components-pagination-paginationrouter--docs).
*/
export function SectionFooterWithPaginationRouter({
page,
size,
total,
config,
className,
linkProps,
}: PaginationRouterProps): ReactElement | null {
variant,
}: SectionFooterWithPaginationRouterProps) {
if (total <= size) {
return null
}

return (
<SectionFooterArea>
<SectionFooterArea variant={variant}>
<PaginationRouter
page={page}
size={size}
Expand Down
4 changes: 4 additions & 0 deletions src/components/section/SectionFooter/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export enum SectionFooterVariant {
Solid = 'SOLID',
Transparent = 'TRANSPARENT',
}
Loading