Skip to content

Commit

Permalink
feat: add IndentSection component
Browse files Browse the repository at this point in the history
  • Loading branch information
adamviktora committed Oct 16, 2024
1 parent ec45977 commit 506f18b
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
# Sidenav top-level section
# should be the same for all markdown files
section: AI-infra-ui-components
# Sidenav secondary level section
# should be the same for all markdown files
id: IndentSection
# Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
source: react
# If you use typescript, the name of the interface to display props for
# These are found through the sourceProps function provided in patternfly-docs.source.js
propComponents: ['IndentSection']
---

import { IndentSection } from "@patternfly/ai-infra-ui-components";

Note: this component documents the API and enhances the [existing IndentSection](https://github.com/opendatahub-io/odh-dashboard/blob/main/frontend/src/pages/projects/components/IndentSection.tsx) component from odh-dashboard. It can be imported from [@patternfly/ai-infra-ui-components](https://www.npmjs.com/package/@patternfly/AI-infra-ui-components). Alternatively, it can be used within the odh-dashboard via the import: `~/pages/projects/components/IndentSection`

### Example

```js file="./IndentSectionBasic.tsx"

```
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import React from 'react';
import { Stack, StackItem } from '@patternfly/react-core';
import { IndentSection } from '@patternfly/ai-infra-ui-components';

export const IndentSectionBasic: React.FunctionComponent = () => {

Check failure on line 5 in packages/module/patternfly-docs/content/examples/IndentSection/IndentSectionBasic.tsx

View workflow job for this annotation

GitHub Actions / call-build-lint-test-workflow / lint

Unexpected block statement surrounding arrow body; move the returned value immediately after the `=>`
return (
<Stack hasGutter>
<StackItem>This text is not indented</StackItem>
<StackItem>
<IndentSection>
This text is wrapped in an IndentSection and thus it is indented
</IndentSection>
</StackItem>
</Stack>
);
};
14 changes: 14 additions & 0 deletions packages/module/src/IndentSection/IndentSection.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import * as React from 'react';
import { Flex, FlexItem } from '@patternfly/react-core';

export type IndentSectionProps = {

Check failure on line 4 in packages/module/src/IndentSection/IndentSection.tsx

View workflow job for this annotation

GitHub Actions / call-build-lint-test-workflow / lint

Use an `interface` instead of a `type`
/** Content rendered inside the IndentSection. */
children: React.ReactNode;
};

export const IndentSection: React.FunctionComponent<IndentSectionProps> = ({ children }: IndentSectionProps) => (
<Flex>
<FlexItem spacer={{ default: 'spacerLg' }} />
<FlexItem flex={{ default: 'flex_1' }}>{children}</FlexItem>
</Flex>
);
1 change: 1 addition & 0 deletions packages/module/src/IndentSection/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './IndentSection';
1 change: 1 addition & 0 deletions packages/module/src/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
export * from './DeleteModal';
export * from './IndentSection';

0 comments on commit 506f18b

Please sign in to comment.