1.2.2 • Published 2 years ago

@ryqndev/image-pane v1.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

@ryqndev/image-pane

A react component to display images when clicked.

Usage

    <ImagePane
        className={cn.image}
        src='https://boba.watch/bobawatch.png'
        alt='boba watch various screens'
        content={{
            tag: '/ boba watch',
            title: 'splash art',
            description:
                'This is an overview of the splash art that was created for the Boba Watch. The splash art is a combination of the the various screens that can be accessed.',
        }}
    />

Light Mode Example Dark Mode Example

Parameters

Prop NameValueExampleRequiredDescription
classNamestringimage-objectNoCustom CSS class for regular image component that triggers image pane
contentClassNamestringcontent-classNoCustom CSS class to style the pane. applied to the parent container only
srcstringhttps://boba.watch/bobawatch.pngYeslink to image. uses html <img> underneath and uses same src attribute
altstringview showing various screens from the appNo, but recommended for a11yalternative text for image
contentobject{ tag: '/ boba watch', title: 'Splash Art', description: 'This is an overview of the splash art that was created for the Boba Watch. The splash art is a combination of the the various screens that can be accessed.' }Nocontent to be displayed on pane

note The content json object does not have to be a string type. It can be a JSX component like so:

    <ImagePane
        className={cn.image}
        src='https://boba.watch/bobawatch.png'
        alt='boba watch various screens'
        content={{
            tag: <>esta<wbr />blishment</>,
            title: 'splash art',
            description:
                'This is an overview of the splash art that was created for the Boba Watch. The splash art is a combination of the the various screens that can be accessed.',
        }}
    />

Above is a simple example that passes in a JSX component rather than a string for the tag property and creates a wordbreak location in the middle of the text but it can be expanded to have complicated components.

Styling

It is preferred to style the colors with CSS variables. Set these variables accordingly to change the colors of the component. If more custom styling is needed, you can do it through the className parameter mention above.

This is an opinionated component and thats why only basic styling is supported naturally.

Variable NameDefault Value
--image-pane-background-color#ffffff
--image-pane-border-color#e0e0e0
--image-pane-title-color#f68080
--image-pane-span-color#ffb3b3
--image-pane-content-color#666
--image-pane-dot-color#f68080
--image-pane-close-border#88888844
--image-pane-box-shadow#aaa
1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.1

2 years ago

0.1.0

2 years ago