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

[image]: merge with image-with-caption #8839

Closed
kennylam opened this issue May 16, 2022 · 0 comments
Closed

[image]: merge with image-with-caption #8839

kennylam opened this issue May 16, 2022 · 0 comments
Assignees
Labels
dev Needs some dev work package: web components Work necessary for the IBM.com Library web components package priority: medium

Comments

@kennylam
Copy link
Member

kennylam commented May 16, 2022

These components should be merged, with caption and lightbox as options.

@kennylam kennylam added dev Needs some dev work package: web components Work necessary for the IBM.com Library web components package priority: medium labels May 16, 2022
@IgnacioBecerra IgnacioBecerra self-assigned this May 24, 2022
kodiakhq bot pushed a commit that referenced this issue May 27, 2022
### Related Ticket(s)
#8839

### Description
This PR merges both Image and Image with caption into one single component. The caption and lightbox options can be activated just as in the Image with caption. Also updated documentation to show that these two components have been merged. Also added a deprecation notice for whoever still uses the Image-with-caption component

### Changelog

**Changed**

- merged `image` and `image-with-caption` into one single component (`image`)
- `image-with-caption` now contains a deprecation notice

**Removed**

- `image-with-caption` stories for both WC and React wrapper

<!-- React and Web Component deploy previews are enabled by default. -->
<!-- To enable additional available deploy previews, apply the following -->
<!-- labels for the corresponding package: -->
<!-- *** "test: e2e": Codesandbox examples and e2e integration tests -->
<!-- *** "package: services": Services -->
<!-- *** "package: utilities": Utilities -->
<!-- *** "RTL": React / Web Components (RTL) -->
<!-- *** "feature flag": React / Web Components (experimental) -->
kodiakhq bot pushed a commit that referenced this issue Apr 6, 2023
### Related Ticket(s)

#10250
https://jsw.ibm.com/browse/ADCMS-3105

### Description

Sets the background style to transparent for the `<button>` element used in the shadow DOM of the `<dds-image>` and `<dds-image-with-caption>` components, such that when used with a transparent image (SVG, transparent gif/png), the browser's default button grey does not show through.

Note that the original issue was reported for `<dds-image-with-caption>`, but the issue equally effects `<dds-image>` component as well. Note also that the `<dds-image-with-caption>` button was recently deprecated, it's features merged with `<dds-image>`. Use of `<dds-image-with-caption>` should be replaced by `<dds-image>` (see #8839). The deprecation is documented in the [Storybook README for the Image component](https://carbon-design-system.github.io/carbon-for-ibm-dotcom/canary/web-components/?path=/docs/components-image--default#image-with-caption).

### Testing Instructions

- [ ] Open Storybook to the Image > Default component. 
- [ ] For the "Default image" Storybook knob, choose "SVG". A transparent SVG is used as the image for the component. 
- [ ] Select Lightbox as well from the Storybook knobs
- [ ] Note the browser default button color does not show through.

### Changelog

**Changed**

- Added `background-color: transparent` to the button styles for the `<dds-image>` component when in lightbox mode.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev Needs some dev work package: web components Work necessary for the IBM.com Library web components package priority: medium
Projects
None yet
Development

No branches or pull requests

2 participants