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.

Sign up for GitHub

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

Jump to bottom

feat(alert): add pf-alert #2593

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

feat(alert): add pf-alert #2593

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
33afe49
feat: init commit with pf-alert
brianferry Aug 28, 2023
df55c1d
feat: truncated title and timeout
brianferry Sep 11, 2023
6185d07
feat(alert): adding plain, custom icons
brianferry Sep 15, 2023
20eaf92
Merge branch 'main' of github.com:patternfly/patternfly-elements into…
brianferry Sep 25, 2023
544a0c6
feat(alert): cleaning up css, fallback variables for important styles…
brianferry Sep 29, 2023
c68683a
feat(core): adding isEmpty, hasSlotted w/ default slot
brianferry Oct 10, 2023
da3c824
chore: adding changeset
brianferry Oct 10, 2023
4a1dacf
Merge branch 'feat/core-default-slot' of github.com:patternfly/patter…
brianferry Oct 10, 2023
9a03851
Update core/pfe-core/controllers/slot-controller.ts
brianferry Oct 11, 2023
147b672
chore: merging with feat/default-slot
brianferry Oct 11, 2023
e1cfe19
fix(core): adding anonymous slot back to SlotController
brianferry Oct 11, 2023
88e079d
Merge branch 'feat/core-default-slot' of github.com:patternfly/patter…
brianferry Oct 11, 2023
8e2cd9e
feat(alert): multiple demos, jsdocs, adding pf-icon
brianferry Oct 13, 2023
d97a4f7
fix(alert): private css variables, moving ICONS call inline, removing…
brianferry Oct 16, 2023
472fa59
docs(alert): inline scripts, heading tags fixing
brianferry Oct 16, 2023
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
29 changes: 23 additions & 6 deletions elements/pf-alert/README.md
View file
Open in desktop
bennypowers marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,11 +1,28 @@
# Alert
Add a description of the component here.
# PatternFly Elements Alert

## Usage
Describe how best to use this web component along with best practices.
`<pf-alert>` is a web component that provides a standard alert interface for displaying important messages to users.

## Installation

Load `<pf-alert>` via CDN:

```html
<pf-alert>
<script src="https://jspm.dev/@patternfly/elements/pf-alert/pf-alert"></script>
```

Or, if you are using [NPM](https://npm.im), install it

```bash
npm install @patternfly/elements
```

</pf-alert>
Then once installed, import it to your application:

```js
import '@patternfly/elements/pf-alert/pf-alert.js';
```


```html
<pf-alert variant="info" header="Info alert title"></pf-alert>
```
18 changes: 18 additions & 0 deletions elements/pf-alert/demo/custom-icons.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<link rel="stylesheet" href="demo.css">
<script type="module" src="pf-alert.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's prefer to inline this stuff, to make the demos easier to grok


<pf-alert header="Custom icon">
<pf-icon slot="icon" set="fas" icon="users" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom info icon" variant="info">
<pf-icon slot="icon" set="fas" icon="box" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom success icon" variant="success">
<pf-icon slot="icon" set="fas" icon="database" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom warning icon" variant="warning">
<pf-icon slot="icon" set="fas" icon="server" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom danger icon" variant="danger">
<pf-icon slot="icon" set="fas" icon="laptop" loading="idle"></pf-icon>
</pf-alert>
22 changes: 22 additions & 0 deletions elements/pf-alert/demo/inline.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<link rel="stylesheet" href="demo.css">
<script type="module" src="pf-alert.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above, re: inline


<h1>
Inline
</h1>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h1>
Inline
</h1>

<pf-alert header="Default inline" inline></pf-alert>
<pf-alert variant="info" header="Info inline" inline></pf-alert>
<pf-alert variant="success" header="Success inline" inline></pf-alert>
<pf-alert variant="warning" header="Warning inline" inline></pf-alert>
<pf-alert variant="danger" header="Danger inline" inline></pf-alert>

<h1>
Inline Plain
</h1>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h1>
Inline Plain
</h1>
<h2>Plain</h2>

<pf-alert header="Default inline" inline plain></pf-alert>
<pf-alert variant="info" header="Info inline" inline plain></pf-alert>
<pf-alert variant="success" header="Success inline" inline plain></pf-alert>
<pf-alert variant="warning" header="Warning inline" inline plain></pf-alert>
<pf-alert variant="danger" header="Danger inline" inline plain></pf-alert>
124 changes: 124 additions & 0 deletions elements/pf-alert/demo/kitchen-sink.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<link rel="stylesheet" href="demo.css">
<script type="module" src="pf-alert.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inline


<pf-alert header="Default alert title"></pf-alert>
<pf-alert variant="info" header="Info alert title"></pf-alert>
<pf-alert variant="success" header="Success alert title"></pf-alert>
<pf-alert variant="warning" header="Warning alert title"></pf-alert>
<pf-alert variant="danger" header="Danger alert title"></pf-alert>

<h1>
Alert Variations
</h1>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h1>
Alert Variations
</h1>
<h2>Variants</h2>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and the rest

<pf-alert header="Success alert title" variant="success" dismissable>
<p>Success alert description. This should tell the user more information about the alert.</p>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert header="Success alert title" variant="success" dismissable>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
</pf-alert>

<pf-alert header="Success alert title" variant="success" dismissable>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert header="Success alert title" variant="success" dismissable>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert header="Success alert title" variant="success" dismissable></pf-alert>

<h1>
Default Icons
</h1>

<pf-alert header="Custom icon">
<pf-icon slot="icon" set="fas" icon="users" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom info icon" variant="info">
<pf-icon slot="icon" set="fas" icon="box" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom success icon" variant="success">
<pf-icon slot="icon" set="fas" icon="database" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom warning icon" variant="warning">
<pf-icon slot="icon" set="fas" icon="server" loading="idle"></pf-icon>
</pf-alert>
<pf-alert header="Custom danger icon" variant="danger">
<pf-icon slot="icon" set="fas" icon="laptop" loading="idle"></pf-icon>
</pf-alert>

<h1>
Plain
</h1>

<pf-alert header="Default plain" plain></pf-alert>
<pf-alert variant="info" header="Info plain" plain></pf-alert>
<pf-alert variant="success" header="Success plain" plain dismissable>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<button slot="actions">Ignore</button>
</pf-alert>
<pf-alert variant="warning" header="Warning plain" plain></pf-alert>
<pf-alert variant="danger" header="Danger plain" plain></pf-alert>

<h1>
Inline
</h1>

<pf-alert header="Default inline" inline></pf-alert>
<pf-alert variant="info" header="Info inline" inline></pf-alert>
<pf-alert variant="success" header="Success inline" inline></pf-alert>
<pf-alert variant="warning" header="Warning inline" inline></pf-alert>
<pf-alert variant="danger" header="Danger inline" inline></pf-alert>

<h1>
Plain
</h1>

<pf-alert header="Default inline" plain></pf-alert>
<pf-alert variant="info" header="Info inline" plain></pf-alert>
<pf-alert variant="success" header="Success inline" plain></pf-alert>
<pf-alert variant="warning" header="Warning inline" plain></pf-alert>
<pf-alert variant="danger" header="Danger inline" plain></pf-alert>

<h1>
Inline Plain
</h1>

<pf-alert header="Default inline" inline plain></pf-alert>
<pf-alert variant="info" header="Info inline" inline plain></pf-alert>
<pf-alert variant="success" header="Success inline" inline plain></pf-alert>
<pf-alert variant="warning" header="Warning inline" inline plain></pf-alert>
<pf-alert variant="danger" header="Danger inline" inline plain></pf-alert>

<h1>
Truncated Title
</h1>

<pf-alert style="width:100px;" truncate-title header="It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness, it was the epoch of belief, it was the epoch of incredulity, it was the season of light, it was the season of darkness, it was the spring of hope, it was the winter of despair."></pf-alert>

<h1>
Timeout
</h1>

<pf-button id="create-timeout-alert">Create default timeout alert</pf-button>
<pf-button id="create-timeout-inline-alert">Create inline timeout alert</pf-button>

<input type="range" id="timeout-range" min="0" max="10000" step="100" value="1000" />
<label for="timeout-range">Timeout: <span id="timeout-value">1000</span>ms</label>
<pf-button id="create-Default-timeout-alert">Create Default timeout alert</pf-button>

<section id="timeout-alerts"></section>
126 changes: 5 additions & 121 deletions elements/pf-alert/demo/pf-alert.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,8 @@
<link rel="stylesheet" href="demo.css">
<script type="module" src="pf-alert.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inline


<pf-alert title="Default alert title"></pf-alert>
<pf-alert variant="info" title="Info alert title"></pf-alert>
<pf-alert variant="success" title="Success alert title"></pf-alert>
<pf-alert variant="warning" title="Warning alert title"></pf-alert>
<pf-alert variant="danger" title="Danger alert title"></pf-alert>

<h1>
Alert Variations
</h1>

<pf-alert title="Success alert title" variant="success" dismissable>
<p>Success alert description. This should tell the user more information about the alert.</p>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert title="Success alert title" variant="success" dismissable>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
</pf-alert>

<pf-alert title="Success alert title" variant="success" dismissable>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert title="Success alert title" variant="success" dismissable>

<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<button slot="actions">View details</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
<button slot="actions">Ignore</button>
</pf-alert>

<pf-alert title="Success alert title" variant="success" dismissable></pf-alert>

<h1>
Default Icons
</h1>

<pf-alert title="Custom icon">
<pf-icon slot="icon" set="fas" icon="users" loading="idle"></pf-icon>
</pf-alert>
<pf-alert title="Custom info icon" variant="info">
<pf-icon slot="icon" set="fas" icon="box" loading="idle"></pf-icon>
</pf-alert>
<pf-alert title="Custom success icon" variant="success">
<pf-icon slot="icon" set="fas" icon="database" loading="idle"></pf-icon>
</pf-alert>
<pf-alert title="Custom warning icon" variant="warning">
<pf-icon slot="icon" set="fas" icon="server" loading="idle"></pf-icon>
</pf-alert>
<pf-alert title="Custom danger icon" variant="danger">
<pf-icon slot="icon" set="fas" icon="laptop" loading="idle"></pf-icon>
</pf-alert>

<h1>
Plain
</h1>

<pf-alert title="Default plain" plain></pf-alert>
<pf-alert variant="info" title="Info plain" plain></pf-alert>
<pf-alert variant="success" title="Success plain" plain dismissable>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<button slot="actions">Ignore</button>
</pf-alert>
<pf-alert variant="warning" title="Warning plain" plain></pf-alert>
<pf-alert variant="danger" title="Danger plain" plain></pf-alert>

<h1>
Inline
</h1>

<pf-alert title="Default inline" inline></pf-alert>
<pf-alert variant="info" title="Info inline" inline></pf-alert>
<pf-alert variant="success" title="Success inline" inline></pf-alert>
<pf-alert variant="warning" title="Warning inline" inline></pf-alert>
<pf-alert variant="danger" title="Danger inline" inline></pf-alert>

<h1>
Plain
</h1>

<pf-alert title="Default inline" plain></pf-alert>
<pf-alert variant="info" title="Info inline" plain></pf-alert>
<pf-alert variant="success" title="Success inline" plain></pf-alert>
<pf-alert variant="warning" title="Warning inline" plain></pf-alert>
<pf-alert variant="danger" title="Danger inline" plain></pf-alert>

<h1>
Inline Plain
</h1>

<pf-alert title="Default inline" inline plain></pf-alert>
<pf-alert variant="info" title="Info inline" inline plain></pf-alert>
<pf-alert variant="success" title="Success inline" inline plain></pf-alert>
<pf-alert variant="warning" title="Warning inline" inline plain></pf-alert>
<pf-alert variant="danger" title="Danger inline" inline plain></pf-alert>

<h1>
Truncated Title
</h1>

<pf-alert style="width:100px;" truncate-title title="It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness, it was the epoch of belief, it was the epoch of incredulity, it was the season of light, it was the season of darkness, it was the spring of hope, it was the winter of despair."></pf-alert>

<h1>
Timeout
</h1>

<pf-button id="create-timeout-alert">Create default timeout alert</pf-button>
<pf-button id="create-timeout-inline-alert">Create inline timeout alert</pf-button>

<input type="range" id="timeout-range" min="0" max="10000" step="100" value="1000" />
<label for="timeout-range">Timeout: <span id="timeout-value">1000</span>ms</label>
<pf-button id="create-Default-timeout-alert">Create Default timeout alert</pf-button>

<section id="timeout-alerts"></section>
<pf-alert header="Default alert title"></pf-alert>
<pf-alert variant="info" header="Info alert title"></pf-alert>
<pf-alert variant="success" header="Success alert title"></pf-alert>
<pf-alert variant="warning" header="Warning alert title"></pf-alert>
<pf-alert variant="danger" header="Danger alert title"></pf-alert>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<pf-alert variant="info" header="Info alert title"></pf-alert>
<pf-alert variant="success" header="Success alert title"></pf-alert>
<pf-alert variant="warning" header="Warning alert title"></pf-alert>
<pf-alert variant="danger" header="Danger alert title"></pf-alert>

we can leave these for variants.html

32 changes: 0 additions & 32 deletions elements/pf-alert/demo/pf-alert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,3 @@
import '@patternfly/elements/pf-alert/pf-alert.js';
import '@patternfly/elements/pf-button/pf-button.js';
import '@patternfly/elements/pf-icon/pf-icon.js';

const createTimeoutAlert = document.getElementById('create-timeout-alert');
const createInlintTimeoutAlert = document.getElementById('create-timeout-inline-alert');
const timeoutRange = document.getElementById('timeout-range');
const timeoutValue = document.getElementById('timeout-value');
const createCustomTimeoutAlert = document.getElementById('create-custom-timeout-alert');
const timeoutAlertsSection = document.getElementById('timeout-alerts');

createTimeoutAlert.addEventListener('click', () => {
const pfeAlert = document.createElement('pf-alert');
pfeAlert.title = 'Default Timeout Alert 8000ms';
pfeAlert.timeout = true;
timeoutAlertsSection.appendChild(pfeAlert);
});

createInlintTimeoutAlert.addEventListener('click', () => {
const pfeAlert = document.createElement('pf-alert');
pfeAlert.title = 'Inline Timeout Alert 8000ms';
pfeAlert.timeout = true;
timeoutAlertsSection.appendChild(pfeAlert);
});

createCustomTimeoutAlert.addEventListener('click', () => {
const pfeAlert = document.createElement('pf-alert');
pfeAlert.title = `Custom Timeout Alert ${timeoutRange.value}ms`;
pfeAlert.timeout = timeoutRange.value;
timeoutAlertsSection.appendChild(pfeAlert);
});

timeoutRange.addEventListener('change', () => {
timeoutValue.innerText = timeoutRange.value;
});
25 changes: 25 additions & 0 deletions elements/pf-alert/demo/plain.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<link rel="stylesheet" href="demo.css">
<script type="module" src="pf-alert.js"></script>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inline


<h1>
Plain
</h1>

<pf-alert header="Default plain" plain></pf-alert>
<pf-alert variant="info" header="Info plain" plain></pf-alert>
<pf-alert variant="success" header="Success plain" plain dismissable>
<p>Success alert description. This should tell the user more information about the alert. <a href="#">This is a link.</a></p>
<button slot="actions">Ignore</button>
</pf-alert>
<pf-alert variant="warning" header="Warning plain" plain></pf-alert>
<pf-alert variant="danger" header="Danger plain" plain></pf-alert>

<h1>
Inline Plain
</h1>

<pf-alert header="Default inline" inline plain></pf-alert>
<pf-alert variant="info" header="Info inline" inline plain></pf-alert>
<pf-alert variant="success" header="Success inline" inline plain></pf-alert>
<pf-alert variant="warning" header="Warning inline" inline plain></pf-alert>
<pf-alert variant="danger" header="Danger inline" inline plain></pf-alert>
Loading
Loading