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

fix(ai-label): update classes from slug to ai-label #17972

Merged
Show file tree
Hide file tree
Changes from all commits
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
18 changes: 9 additions & 9 deletions packages/react/src/components/AILabel/AILabel.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import * as AILabelStories from './AILabel.stories';

# AILabel

[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/react/src/components/Slug)
[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/react/src/components/AILabel)
|
[AILabel release status](https://airtable.com/appCAqlGVN8tRUbAp/shr71ZyLlIGORz3Vh/tblHqPusgkK8hIeHo)
|
Expand Down Expand Up @@ -80,7 +80,7 @@ callout. To achieve this, you can pass in `AILabelActions` as a child of
If needed, you can change the text inside the `AILabel` when translating to
different languages.

<AILabel aiText="IA" className="sbdocs-slug">
<AILabel aiText="IA" className="sbdocs-ai-label">
<AILabelContent>Explanation of AI generated content</AILabelContent>
</AILabel>

Expand All @@ -95,11 +95,11 @@ different languages.
When using the `inline` variant, you can add text adjacent to the AI label with
the `aiTextLabel` prop.

<AILabel kind="inline" textLabel="Text goes here" className="sbdocs-slug">
<AILabel kind="inline" textLabel="Text goes here" className="sbdocs-ai-label">
<AILabelContent>Explanation of AI generated content</AILabelContent>
</AILabel>
<br />
<AILabel kind="inline" className="sbdocs-slug">
<AILabel kind="inline" className="sbdocs-ai-label">
<AILabelContent>Explanation of AI generated content</AILabelContent>
</AILabel>

Expand All @@ -117,7 +117,7 @@ the `aiTextLabel` prop.

The `AILabel` component has two variants, `default` and `inline`.

<AILabel size="xs" className="sbdocs-slug">
<AILabel size="xs" className="sbdocs-ai-label">
<AILabelContent>AI was used to generate this content</AILabelContent>
</AILabel>

Expand All @@ -130,7 +130,7 @@ The `AILabel` component has two variants, `default` and `inline`.
The `inline` `AILabel` with the standard icon can also trigger the AI
explainability callout.

<AILabel kind="inline" textLabel="Text goes here" className="sbdocs-slug">
<AILabel kind="inline" textLabel="Text goes here" className="sbdocs-ai-label">
<AILabelContent>Explanation of AI generated content</AILabelContent>
</AILabel>

Expand All @@ -147,12 +147,12 @@ the `AILabel` into a revert action button. This is useful if a user edits an
AI-generated input to show that the element has been modified. This can be used
in conjunction with the `onRevertClick` callback to handle restoring the element
to the AI-generated state. For an example, please take a look at the
[Revert Test story](https://react.carbondesignsystem.com/?path=/story/experimental-unstable-slug-form--revert-test)
[Revert Test story](https://react.carbondesignsystem.com/?path=/story/components-form--with-ai-label&args=revertActive:!true)
or take a look at the example story
[source code](https://github.com/carbon-design-system/carbon/blob/main/packages/react/src/components/Slug/Slug-form.stories.js#L96).
[source code](https://github.com/carbon-design-system/carbon/blob/main/packages/react/src/components/Form/Form.stories.js#L272).

## Feedback

Help us improve this component by providing feedback, asking questions on Slack,
or updating this file on
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/react/src/components/Slug/Slug.mdx).
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/react/src/components/AILabel/AILabel.mdx).
22 changes: 11 additions & 11 deletions packages/react/src/components/AILabel/AILabel.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const aiContent = (

export const Default = () => (
<>
<div className="slug-container slug-container-example">
<div className="ai-label-container ai-label-container-example">
<AILabel autoAlign size="mini">
<AILabelContent>{aiContent}</AILabelContent>
</AILabel>
Expand Down Expand Up @@ -134,7 +134,7 @@ export const Default = () => (
</AILabelContent>
</AILabel>
</div>
<div className="slug-container-example slug-container">
<div className="ai-label-container ai-label-container-example">
<AILabel autoAlign kind="inline" size="sm">
<AILabelContent>
{aiContent}
Expand Down Expand Up @@ -187,7 +187,7 @@ export const Default = () => (
</AILabelContent>
</AILabel>
</div>
<div className="slug-container-example slug-container">
<div className="ai-label-container ai-label-container-example">
<AILabel autoAlign kind="inline" size="sm" textLabel="Text goes here">
<AILabelContent>
{aiContent}
Expand Down Expand Up @@ -244,10 +244,10 @@ export const Default = () => (
);

export const ExplainabilityPopover = (args) => {
const { showSlugActions = true } = args;
const { showAILabelActions = true } = args;

return (
<div className="slug-container-example slug-container centered">
<div className="ai-label-container-example ai-label-container centered">
<AILabel autoAlign={false} defaultOpen {...args}>
<AILabelContent>
{' '}
Expand All @@ -264,7 +264,7 @@ export const ExplainabilityPopover = (args) => {
<p className="secondary">Model type</p>
<p className="bold">Foundation model</p>
</div>
{showSlugActions && (
{showAILabelActions && (
<AILabelActions>
<IconButton kind="ghost" label="View">
<View />
Expand All @@ -285,7 +285,7 @@ export const ExplainabilityPopover = (args) => {
};

ExplainabilityPopover.argTypes = {
showSlugActions: {
showAILabelActions: {
control: {
type: 'boolean',
},
Expand Down Expand Up @@ -384,7 +384,7 @@ ExplainabilityPopover.argTypes = {
};

export const Playground = (args) => {
const { showSlugActions = true } = args;
const { showAILabelActions = true } = args;

const renderedContent = (
<>
Expand All @@ -400,7 +400,7 @@ export const Playground = (args) => {
<p className="secondary">Model type</p>
<p className="bold">Foundation model</p>
</div>
{showSlugActions && (
{showAILabelActions && (
<AILabelActions>
<IconButton kind="ghost" label="View">
<View />
Expand All @@ -419,7 +419,7 @@ export const Playground = (args) => {

return (
<>
<div className="slug-container slug-container-example">
<div className="ai-label-container ai-label-container-example">
<AILabel aria-label="Test" {...args}>
<AILabelContent>{renderedContent}</AILabelContent>
</AILabel>
Expand All @@ -431,7 +431,7 @@ export const Playground = (args) => {
};

Playground.argTypes = {
showSlugActions: {
showAILabelActions: {
control: {
type: 'boolean',
},
Expand Down
16 changes: 8 additions & 8 deletions packages/react/src/components/AILabel/AILabelDatatable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { AILabel, AILabelContent, AILabelActions } from '.';

# AILabel

[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/react/src/components/Slug)
[Source code](https://github.com/carbon-design-system/carbon/tree/main/packages/react/src/components/AILabel)
|
[AILabel release status](https://airtable.com/appCAqlGVN8tRUbAp/shr71ZyLlIGORz3Vh/tblHqPusgkK8hIeHo)
|
Expand All @@ -22,7 +22,7 @@ import { AILabel, AILabelContent, AILabelActions } from '.';

## Overview

The `DataTable` supports placing a `slug` in both the column header and row.
The `DataTable` supports placing a `AI label` in both the column header and row.

<Canvas id="components-datatable-withailabel--column-ai-label-with-selection-and-expansion" />

Expand Down Expand Up @@ -50,7 +50,7 @@ callout. To achieve this, you can pass in `AILabelActions` as a child of
<AILabel>
<AILabelContent>
{Content Here}
{Optional Slug action bar}
{Optional AI label action bar}
<AILabelActions>
<IconButton kind="ghost" label="View">
<View />
Expand All @@ -71,7 +71,7 @@ callout. To achieve this, you can pass in `AILabelActions` as a child of

### Using as a column header

To use an `AILabel` inside a column header, you'll need to add a `slug` to the
To use an `AILabel` inside a column header, you'll need to add a `AILabel` to the
appropriate column data.

```jsx
Expand All @@ -83,9 +83,9 @@ const columnAILabelHeaders = [
{
key: 'attached_groups',
header: 'Attached groups',
slug: (
AILabel: (
<AILabel
className="slug-container"
className="ai-label-container"
autoAlign={false}
align="bottom-right">
<AILabelContent>
Expand Down Expand Up @@ -139,7 +139,7 @@ To use an `AILabel` inside a `DataTable` row, you'll need to pass in your
<TableBody>
{rows.map((row, i) => (
<TableRow key={i} {...getRowProps({ row })}>
<TableSlugRow slug={slug} />
<TableSlugRow slug={AILabel} />
<TableSelectRow {...getSelectionProps({ row })} />
{row.cells.map((cell) => (
<TableCell key={cell.id}>{cell.value}</TableCell>
Expand All @@ -153,4 +153,4 @@ To use an `AILabel` inside a `DataTable` row, you'll need to pass in your

Help us improve this component by providing feedback, asking questions on Slack,
or updating this file on
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/react/src/components/Slug/SlugDatatable.mdx).
[GitHub](https://github.com/carbon-design-system/carbon/edit/main/packages/react/src/components/AILabel/AILabelDatatable.mdx).
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ describe('AILabel', () => {
const wrapper = render(<AILabel kind="inline" textLabel="Test text" />);

const additionalTextSpan = wrapper.container.querySelector(
`.${prefix}--slug__additional-text`
`.${prefix}--ai-label__additional-text`
);
expect(additionalTextSpan).toBeInTheDocument();
expect(additionalTextSpan).toHaveTextContent('Test text');
Expand All @@ -56,7 +56,7 @@ describe('AILabel', () => {
const wrapper = render(<AILabel textLabel="Test text" />);

const additionalTextSpan = wrapper.container.querySelector(
`.${prefix}--slug__additional-text`
`.${prefix}--ai-label__additional-text`
);
expect(additionalTextSpan).not.toBeInTheDocument();
});
Expand Down Expand Up @@ -89,14 +89,14 @@ describe('AILabel', () => {
render(<AILabel kind="inline" />);

expect(screen.getByRole('button')).toHaveClass(
`${prefix}--slug__button--inline`
`${prefix}--ai-label__button--inline`
);
});

it('should respect revertActive prop', () => {
const { container } = render(<AILabel revertActive />);

expect(container.firstChild).toHaveClass(`${prefix}--slug--revert`);
expect(container.firstChild).toHaveClass(`${prefix}--ai-label--revert`);
expect(container.firstChild.firstChild).toHaveClass(
`${prefix}--icon-tooltip`
);
Expand All @@ -112,7 +112,7 @@ describe('AILabel', () => {
render(<AILabel size="xl" />);

expect(screen.getByRole('button')).toHaveClass(
`${prefix}--slug__button--xl`
`${prefix}--ai-label__button--xl`
);
});
});
Expand Down
Loading
Loading